Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 1.64 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Code of conduct

Please note we have a README, please follow it in all your interactions with the project.

Pull Request

  1. Fork it!

  2. Checkout branch develop

    git checkout develop

  3. Create your feature branch (from branch develop)

    git checkout -b feature/my-new-feature

    We are using git-flow, so create branch feature/new-feature (for new features) or hotfix/new-hotfix (for fixing bugs).

  4. Commit your changes (remember to check if code compiles without errors and tests pass)

    git commit -m 'Add some feature'

  5. Push to the branch

    git push origin my-new-feature

  6. If you've added code that should be tested, add tests.

  7. If necessary, update the documentation (README.md).

  8. Ensure the tests pass.

  9. Make sure your code compiles without errors.

  10. Create a pull request to develop branch (the template has already been created, simply complete it).

Suggest a new feature

We use GitHub issues to track public features. Suggest a new feature by opening a new issue.

Report bug

We use GitHub issues to track public bugs. Report a bug by opening a new issue with label bug.

License

By contributing, you agree that your contributions will be licensed under MIT License.