Setting Up an Open Source Repository
Professionalizing and standardizing the way of working for (open source) repositories
This guide describes the steps to setup an (open source) repository based on a recommended workflow. The goal is to professionalize and standardize the way of working and were possible automate and enforce this.
Of course it can also be used for closed source repositories, as any development team can benefit from these principles.
I wrote this document when I was setting up my first open source repositories, because there was a lot to learn, which cost a lot of effort. All the information is out there, but it is not conveniently in one place, often outdated or to much or to little information to get a good understanding. I wanted to document this for myself and decided to share it with others so that they can profit from my effort.
This is a living document. I will continue to add to this document as needed and enhance it where needed.
Enjoy!
We welcome pull requests! What follows is the simplified version of the contribution process, please read here to fully understand our contribution policy and here to understand our code of conduct.
- Fork the repository here!
- Create your feature branch:
git checkout -b my_new_feature - If relevant, don't forget to add your tests and comment your code
- Commit your changes:
npm run commit - Push the branch:
git push origin my-new-feature - Submit a pull request :-)
TIP Learn all about forking a repo here. More information on cloning a repo here.
If you like this project, please support us by starring ⭐ this repository. Thx!
Please let the world know about us! Brag about us using Twitter, email, blog, Discord, Slack, forums, etc. etc. Thx!
nidkil © nidkil, released under the MIT license. Authored and maintained by nidkil with help from contributors.