Ok, so you’ve familiarized yourself with the rules. Good. This isn’t Fight Club, but they are important rules. You want to be a professional in all the projects on which you want to participate. If properly managed, your GitHub account should be a functional part of your ever-evolving resume.
So, code itself really isn’t hard to organize. But you’d be surprised how many people just don’t get it. Since I usually develop in python, here is my standard project directory structure:
./new_project. ├── CONTRIBUTING.md ├── doc ├── LICENSE.md ├── README.md ├── scripts ├── setup.py ├── src └── tests
If you code in a different language which has different structural requirements, make changes. This is how I do it.
First, the markdown files:
I’m not going to worry over the preference for ReStructuredText, Markdown, LaTeX, or basic text for these files. Feel free to do your own research and come to your own conclusions.
This document is optional for simple projects. It is possible to have this as part of the README. In this document, you should spell out how people can contribute to your project. Should they fork and submit pull requests? How should they report issues and/or request new features? These are important questions. Not just for potential compatriots, but for you.
This should have the text of the license under which you are placing the project. You can cut and paste this from any number of reputable licensing sources. I recommend reading about the different licenses here. I will also be going over the primary players in a future post.
I feel that the project README is non-optional. This single document should have key information about the project. It should (ideally) address the following:
- What is the purpose of this project? Think of it as the two-to-three sentence description of the project. What problem were you trying to solve?
- Where to find more documentation.
- Installation instructions
- Simple configuration settings – if appropriate.
- Possibly simple use-cases and examples.
DONATIONS.md/SPONSOR.md – Where/how to send any monetary donations. A good example of what might be found in a donations/sponsorship doc can be found here.
THANKS.md – If you want to thank anyone for help or encouragement, this would be alright to add. Completely optional.
Now the directories:
This is where your project documentation should reside. If you do this correctly, you can easily get them posted to
This is optional for projects which have no need for command-line scripts. But, if your project has a command-line tool associated with it, you should really consider having them in this directory.
This is where your code should reside.
This is where the tests for your code should be found. Having tests is a big indicator of the health and maturity of the project. The tests here should show that you take the writing and maintaining of the code very seriously.
examples – Some people like to house some usage examples here. If appropriate, feel free.