Thursday, February 9, 2017

Creating an open source project: Getting Started

I have been working on the DissectPCOFFBinary project for a bit now, and I have gotten to the stage that I want to share it.  The best thing to do is to create a GitHub project, so what steps do I need to go through?  How do I get started?  What are the steps?  Here is what I have found:

1:    Create a License file, I am using the MIT License template
The MIT License
Copyright (c) 2017 Larry Smithmier

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
From: https://opensource.org/licenses/MIT
2:    Create a README.md file

# Dissect PECOFF Binary #
This is the Source Code location for DissectPECOFFBinary application. 

Please see the [C# For 
You](http://www.csharp4u.com/search/label/DissectPCOFFBinary) 
blog for the latest posts on the applicaton.

*"Sharing is Caring"*

This project has adopted the 
[Microsoft Open Source Code of 
Conduct](https://opensource.microsoft.com/codeofconduct/). 
For more information see the 
[Code of Conduct 
FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact 
[[email protected]](mailto:[email protected]) 
with any additional questions or comments.
3:    Create a CONTRIBUTING.md file
# Contribution guidance

*work in progress*

This repository contains the code described in 
[Reading Structured Binary Files in 
C#](
http://www.csharp4u.com/2017/02/reading-structured-binary-files-in-c.html 
"C#4U blog post on reading binary files in C#").  
Follow the standard Open Source process on getting started and contributing. 
See the wiki pages from the main 
repository for additional details. 

---

4:    Install the GitHub Desktop to make it easier
5:    Create a new repository in GitHub Desktop
Create a new GitHub Repository
6:    Add a check-in note and description and Commit to master
Commit changes to master
7:    Publish the changes to GitHub
Publish the changes to GitHub
8:    Check your repository!
Check your repository
That is all for now.  That is the minimum I feel comfortable with.  There are tons of things to add, including a project site and Wiki.  I will continue to post about changes I make to the project as I make them.

Keep your code clean!




No comments:

Post a Comment