Initial Changes¶
At this point, you now have your template repository on GitHub and locally on your machine. Now it's time to start making some modifications.
README¶
The first thing to do is update the README (/README.md
), which should contain a user-friendly summary of what your package is all about. This can be whatever you want. Feel free to be creative!
License¶
The template repository comes premade with a sample license (/LICENSE.md
), in this case the very popular and permissive BSD 3-Clause license. Feel free to change this for your own project or keep it as-is if you don't quite know yet.
Tip
There are many licenses that one can consider. A comprehensive list can be found on the Open Source Initiative website, but a less overwhelming route is to use choosealicense.com.
Code of Conduct¶
The template repository ships with a premade Code of Conduct (/CODE_OF_CONDUCT.md
) that is obtained from the Contributor Covenant. Of course, you can feel free to keep or change this as you see fit, but it is often a good idea to have a code of conduct for public repositories.