These are the bare essentials of project documentation and metadata, but you may find some additional files useful in certain situations:
- TODO.txt: A shortlist of bugs or missing features that need work
- CHANGELOG.txt: A log of the history of major project changes and releases
- tests: A directory containing unit tests for your module
- scripts: A directory containing Python or shell scripts that are useful to, but not part of, your module
- Makefile: Some projects benefit from a scripted build process, and for that, a utility such as make can be helpful; alternatives include CMake, SCons, or Waf
At this point, though, your project is ready to upload to your favorite source code-sharing site. In the next section, we'll look at getting ...