Contributing

Contributing

This project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.

For bug fixes, documentation changes, and small features:

1. Fork it ( https://github.com/OpenFlame/OpenFlame/fork ).
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin my-new-feature).
5. 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.

Checklist

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 owners permission.

Commit Message

Commit messages should start with a single-line title which gives a quick outline of the commit, followed by a blank line and then one or more paragraphs which describe the changes in more detail.

Title

The title should be a single line which gives a high-level description of the commit. A simple test is the write the title such that it completes the sentence "If submitted, this commit will ".

Body

The body should explain in detail what this commit does and why this is the best implementation.

Extra

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 the bug after the body. Or if the commit is related to larger change, it should have a link to other commits and/or documents.

Copyright

By contributing to the project, contributors agree to assign the contribution's copyright to the project's owner, to be licensed under the same terms as the rest of the project.