We are thrilled that you are interested in contributing to this project.
If you have suggestions for how this project could be improved, or want to or want to report a bug, then please open an issue. We love all kinds of contributions. If you have questions, we'd love to hear them too - you can either open an issue or reach out to project leadership directly at mmckerns[@]uqfoundation.org.
We also love PRs. Please feel free to submit a PR. If you're thinking of opening a large PR, or a PR that implements a significant change to existing code, then we advise opening up an issue first to discuss your proposed change. Doing so can make it easier to get your contribution merged. If you're not sure how to open a PR, check the links to the resources below.
When reporting issues please include as much detail as possible about your operating system, python version, package version, and the versions of any relevant package dependencies. Whenever possible, it is strongly suggested to include a brief, self-contained code example that demonstrates the issue you are experiencing. Doing so makes it easier for us to try to reproduce your issue, which is the first step in working toward solving it. If your example code generates a traceback, feel free to also include the traceback as it can be very useful in diagnosing the issue.
Contributions to this project are released to the public under the project's open source license. Essentially, when you add content to this project, you license that content under the same terms. Hence, unless you have a separate agreement with the UQ Foundation to license your content under different terms, such as a contributor license agreement, the project's license will be applied to your contribution. If you are contributing code that someone else wrote, please check with that code's license (and/or author) to ensure all license stipulations are met and the code is able to be released under this project's license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See CODE_OF_CONDUCT.md.
If you aren't familiar with submitting a pull request, then check the links to the resources below. Once you have prepared your pull request, you will need to get it reviewed before it can be merged. Here are a few things that you can do to increase the likelihood your pull request will be accepted:
- Follow standards for style and code quality.
- Write tests that confirm the behavior of any new code.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- If you have a large or complex pull request, then please do open an issue first to discuss your proposed change.
- Write a good commit message.
- When you are ready for your pull request to be reviewed, tag project leadership (@mmckerns) requesting a review.
"Work in Progress" pull requests are welcome to get feedback early on, or if there is something that is blocking your progress. If you have questions about the code, or want to discuss your work in progress, then tag project leadership (@mmckerns) on your pull request.