Follow these easy steps and guidelines to ensure swift acceptance of pull requests into Git Versioner and the improved likelihood of seeing your changes reflected in a release version sooner.
Following the contribution workflow will ensure that your development won't go unnoticed and will be merged into the main repository in a quicker timeframe than if the workflow isn't followed.
-
Open an issue in GitHub with the bug, improvement, or feature request with information about your proposed changes. This will allow discussion over the changes to occur.
-
Fork the repository.
-
Make your changes and submit a pull request from your fork into master branch.
-
The pull request will run through GitHub Actions to ensure it compiles and tests pass.
-
The pull request will be reviewed and comments made and changes requests where required.
-
When ready, the pull request will be merged into master branch and automatically included in the next release.
Contributions will be merged in a lot quicker if you follow these guidelines:
-
Include unit tests for all new logic introduced.
-
Integration tests should be included where sensible.
-
Include documentation in the README for new features.
We use commit messages as a form of documentation, so it's important that they contain enough information to be useful.
-
Use a concise title for the commit summary line.
-
Include extra information in the main body of the commit message. This can be in bullet points or sentences, and is supposed to give context around why the change was made and reasons for the design decisions made, and any shortcomings of the solution that may need to be looked at again.
-
Keep commits discrete and self-contained. Change one thing per commit, and ensure each commit makes sense in isolation.