Contributions (bug reports, fixes, documentation, enhancements, ideas, ...) are welcome and appreciated.
To get started, find the best path for your contribution:
- Ask questions, discuss models, and present ideas in Discussions.
- Report bugs or suggest changes as Issues.
- Contribute fixes or improvements as Pull Requests.
Please follow the Github Community Guidelines when participating in any of these forums.
The following emulates the xarray contributing guidelines.
Documentation is written in reStructuredText and synthesized with Sphinx.
For small changes, fork and edit files directly in the Github interface.
For larger changes:
- Set up a local development environment.
- Edit documents and notebooks following existing conventions.
- Build and review the documentation locally:
# docs build to directory docs/_build/html
$ make docs-build- Submit changes as a Pull Request.
If you are new to development, see xarray's Working with the code. This reference provides an introduction to version control, git, Github, Forking, and creating branches.
For more involved changes, create a Github Issue describing the intended changes first.
Once you're ready to develop:
- Set up a local development environment.
- Implement updates. Make sure code is documented using existing conventions.
- Ensure tests pass locally:
$ make test- Submit changes as a Pull Request.