Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
Questions and discussion topics can be proposed using discussions.
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
- A reproducible test case or series of steps
- The version of our code being used
- Any modifications you've made relevant to the bug
- Anything unusual about your environment or deployment
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
- You are working against the latest source on the master branch.
- You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
- You open an issue to discuss any significant work - we would hate for your time to be wasted.
To send us a pull request, please:
- Fork the repository.
- Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
- Ensure local tests pass by executing
pytest
. - Commit to your fork using clear commit messages.
- Send us a pull request, answering any default questions in the pull request interface.
- Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
GitHub provides additional document on forking a repository and creating a pull request.
For development you need the requirements listed in all requirements...txt
files.
We use black and mypy for style and type checking. Any code changes that you contribute should pass these checks.
The easiest way to get set up for development is to run the following script:
# first fork the repo on github
# then clone your fork
git clone https://github.com/<your-github-username>/gluon-ts.git
# enter the cloned repo
cd gluon-ts
# run development setup
./dev_setup.sh
# install GluonTS from current source with shell dependencies
pip install -e ".[shell]"
Note that windows and other versions of linux (not mac versions) will require
something slightly different to initiate the dev_setup.sh
script.
This will install all the requirements and also install a git hook that runs all code checks when you commit. This also separates your workflow so that pull-requests go through your forked repo and then into upstream if approved.
You may wish to familiarize yourself with forked repositories on github, for more see: https://help.github.com/en/articles/working-with-forks
To avoid conflicts with existing python installations you may want to setup a virtual environment. For more on virtual environments in python see: https://docs.python.org/3/tutorial/venv.html for python virtual environments and https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html for conda virtual environments.
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opensource-codeofconduct@amazon.com with any additional questions or comments.
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.
See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.
We may ask you to sign a Contributor License Agreement (CLA) for larger changes.