Contribute to Nixtla
Thank you for your interest in contributing to Nixtla. Nixtla is free, open-source software and welcomes all types of contributions, including documentation changes, bug reports, bug fixes, or new source code changes.
Contribution issues 🔧
Most of the issues that are open for contributions will be tagged with good first issue or help wanted. A great place to start looking will be our GitHub projects for:
Also, we are always open to suggestions so feel free to open new issues with your ideas and we can give you guidance!
After you find the issue that you want to contribute to, follow the fork-and-pull workflow:
- Fork the Nixtla repository you want to work on (e.g. StatsForecast or NeuralForecast)
- Clone the repository locally (
git clone) and create a new branch (git checkout -b my-new-branch) - Make changes and commit them
- Push your local branch to your fork
- Submit a Pull Request so that we can review your changes
- Write a commit message
- Make sure that the CI tests are GREEN (CI tests refer to automated tests that are run on code changes to ensure that new additions or modifications do not introduce new errors or break existing functionality.)
You can find a complete step-by-step guide on this fork-and-pull workflow here.
Pull Request reviews are done on a regular basis. Please make sure you respond to our feedback/questions and sign our CLA.
Documentation 📖
We are committed to continuously improving our documentation. As such, we warmly welcome any Pull Requests that focus on improving our grammar, documentation structure, or fixing any typos.
- Check the
documentationtagged issues and help us.
Write for us 📝
Do you find Nixtla useful and want to share your story or create some content? Make a PR to this repo with your writing in a markdown file, or just post it on Medium, Dev or your own blog post. We would love to hear from you 💚
Give us a ⭐ on Github