Contributing

[Status: Draft]

This project has a Code of Conduct that we expect all of our contributors to abide by, please check it out before contributing.

Pull requests and branching

  • Before working on a feature always create a new branch first. (or fork the project).

  • Branches should be short lived, except branches specifically labelled 'experiment'.

  • Once work is complete push the branch up on to GitHub for review. Make sure your branch is up to date with master before making a pull request. Eg. use git merge origin/master

  • Once a branch has been merged into master, delete it.

master is never committed to directly unless the change is very trivial or a code review is unnecessary (code formatting or documentation updates for example).

License

By contributing to benchmarkstt, you agree that your contributions will be licensed under the :doc:LICENSE.md file in the root directory of this source tree.