Skip to content

Latest commit

 

History

History
83 lines (46 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

83 lines (46 loc) · 2.85 KB

How to contribute

Not implemented todo

Thats great, we are happy that you want to contribute

Some resources to start

Licensing

Not implemented todo

By contributing e.g. through opening a pull request or submitting a patch, you represent that your contributions are your own original work and that you have the right to license them, and you agree that your contributions are licensed under the Apache 2.0 license.

Submitting bug reports

Not implemented todo

Open an issue on GitHub to report bugs or other problems.

If reporting an error when running please include a full traceback in your issue.

Submitting changes

Not implemented todo

Look at the development guide in our documentation for information on how to get set up for development.

To contribute changes:

  1. Fork the project on GitHub
  2. Create a feature branch to work on in your fork (git checkout -b new-fix-or-feature)
  3. Add your name to the AUTHORS file
  4. Commit your changes to the feature branch
  5. Push the branch to GitHub (git push origin new-fix-or-feature)
  6. On GitHub, create a new pull request from the feature branch

Our development guide gives a more detailed description of each step, if you're new to working with GitHub.

Pull requests

Not implemented todo

Before submitting a pull request, check whether you have:

  • Added your changes to changelog.rst
  • Added or updated documentation for your changes
  • Added tests if you implemented new functionality

When opening a pull request, please provide a clear summary of your changes!

Commit messages

Not implemented todo

Please try to write clear commit messages. One-line messages are fine for small changes, but bigger changes should look like this:

A brief summary of the commit

A paragraph or bullet-point list describing what changed and its impact,
covering as many lines as needed.

Testing

Not implemented todo

All tests are in the test directory and use

Coding conventions

Not implemented todo

Attribution

The layout and content of this document is partially based on the calliope-project.