Thanks for your time and willingness to contribute to Campo! This page gives a few guidelines:
Reporting issues
If you have found a bug in the Campo software (or any other erroneous behaviour) please file a bug report. Bugs are tracked on our GitHub issue page. To allow us to reproduce the issue please provide as much information as possible such that we can reproduce the bug:
- The Campo version and the Python version used.
- Details about the operating system used.
- The description of the problem in as much detail as possible.
- If possible, a minimal working example and zip or archive file with all data and scripts.
Solving issues
If you find an issue to work on, you are welcome to open a pull request with a fix.
Pull requests
In case you can provide a code fix yourself or want to contribute additional functionality to Campo please consider submitting a pull request.
For something that is bigger than a trivial fix follow these steps:
- Create an issue describing the changes you intend to make.
- Create your own fork of the Campo code, or make sure it is in sync with the upstream project.
- Create a branch with the corresponding issue number.
- Switch to that branch.
- Apply your modifications.
- Ensure cross-platform compatibility; for Linux, Mac, and Windows. Preferably provide unit tests as well.
Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Campo team member will review your proposal. We may ask questions, request additional information or may ask for changes to be made before a PR can be merged.
All contributions to this project will be released under the MIT license. By submitting a pull request:
- You are agreeing to comply with the waiver of your copyright interest.
- You state that the contribution was created in whole by you and you have the right to submit it.