Documentation of Coding Standards

dreamteamrepos / bashellite

Like another repository manager you may know, but with the ability to sync more than just rpm mirrors.

MIT License

2 stars 5 forks source link

Documentation of Coding Standards #46

Open ragingpastry opened 6 years ago

ragingpastry commented 6 years ago

It would be nice to have a CONTRIBUTING.md document to define the process for contributing new changes to this project.

Some things that we could document include:

bash coding standards. Whether this is a link to Google's Bash standards or something custom..
Git commit / branching standards
Some examples for setting up a development environment
Documentation on how the whole system is put together, from an architecture point of view.

codrcodz commented 6 years ago

Agreed. Now that we are getting a little closer to a production release, and we've on-boarded someone that hasn't been working with the project since early in its development, I think now is the appropriate time to make the investment and write out some more in-depth documentation.

ragingpastry commented 6 years ago

Sounds great.

Documentation of commit / branching standards will be important as well. I am partial to the Stable Mainline strategy, however anything would work. As long as we have a standard and stick to that.

http://www.bitsnbites.eu/a-stable-mainline-branching-model-for-git/

pcseanmckay commented 6 years ago

Take a look at this article. It is essentially what we are doing... https://barro.github.io/2016/02/a-succesful-git-branching-model-considered-harmful/

ragingpastry commented 6 years ago

Yup that is the other article that I have been looking at as well. If that is essentially what you guys have been doing then we can get something written up in a CONTRIBUTING.md document to clearly define what a new change should look like.