CONTRIBUTING.md (1754B)
1 # Contribution Guide 2 3 Great you are reading this helpful and very important guide. I dried to keep things short. Feel free to jump to the most suitable section. 4 5 ## I Have Great Ideas... 6 If you were facing some bugs or have some great ideas for improvement apply for **reporter** access. Create separate issues. 7 8 9 ## Wanna Pitch in... 10 11 Great you get your hands dirty! Apply for **developer** access and send your changes as merge request on separate branches. For branch namespaces read below. 12 13 ## Notes for Developers 14 15 ### Branch Naming 16 17 * Each new feature **must** be developed in its own branch. The feature branches are post-fixed with the namespace name *fb/* which stands for feature branch. 18 * Bug fixes or more precisely **hotfixes** are as well in separated branches and close one and only one particular issue. Such issues are flagged as bug. The namspace name for hotfixes is *hf/* 19 20 ### Merging 21 * It is allowed to merge directly from **hf/** to master. Increment patch counter. 22 * A merge from develop branch into muster undergoes a review and test. 23 * New features are merged into develop branch and from develop branch into master. Increment minor number counter. 24 * Massive changes and API changes will result in a new major release. Major releases are not backward compatible. 25 26 ### Semantic Versions 27 28 Given a version number MAJOR.MINOR.PATCH, increment the: 29 * MAJOR version when you make incompatible API changes, 30 * MINOR version when you add functionality in a backwards-compatible manner, and 31 * PATCH version when you make backwards-compatible bug fixes. 32 33 Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. 34 35 *For further reading see here https://semver.org/