-
Notifications
You must be signed in to change notification settings - Fork 1
Contributing
This project has a Code of Conduct and by participating in this project you agree to abide by its terms.
For bug fixes, documentation changes, and small features:
- Fork it ( https://github.com/stuartmscott/OpenFlame/fork ).
- Create your feature branch (
git checkout -b my-new-feature). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Create a new Pull Request.
For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction.
Please ensure contributions to the project
- are high-quality, useful and aligned with the direction of the project.
- includes enough tests to convince peers of its quality, efficiency and stability.
- compiles, runs, and passes all tests.
- complies with the style and commit message guides.
- are your copyright or you have the owner's permission.
Commit messages start with a title which gives a quick outline of the commit, followed by a blank line and then a body which describe the changes in more detail, if necessary.
The title should be a single line which gives a high-level description of the commit. A simple test is to write the title such that it completes the sentence "If submitted, this commit will...".
The body should explain in detail what this commit does and how, why it is needed, and why it is the best approach.
The message should contain all information to help peers understand the change, even if they read it long after the commit was made. For example, if a commit fixes a bug, the message should have a link to it. Or if the commit is related to larger change, it should have a link to its accompanying commits, discussions and/or documents.
By contributing to the project, contributors agree to assign the contribution's copyright to the project, to be licensed under the same terms as the rest of the project.
Copyright (C) 2015 OpenFlame Project. Licensed under the GNU General Public License.