Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report bugs at https://github.com/cedadev/xarray-pickler/issues.
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
xarray-pickler could always use more documentation, whether as part of the official xarray-pickler docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/cedadev/xarray-pickler/issues.
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Ready to contribute? Here’s how to set up xarray-pickler for local development.
Fork the xarray-pickler repo on GitHub.
Clone your fork locally:
$ git clone email@example.com:your_name_here/xarray-pickler.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv xarray_pickler $ cd xarray-pickler/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you are done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 clisops tests $ black --target-version py36 clisops tests $ pytest tests
To get flake8, black, and tox, just pip install them into your virtualenv. Alternatively, you can use pre-commit to perform these checks at the git commit stage:
$ pip install pre-commit $ pre-commit install $ pre-commit run --all-files
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 3.6, 3.7 and 3.8. Check https://travis-ci.com/cedadev/xarray-pickler/pull_requests and make sure that the tests pass for all supported Python versions.
To run a subset of tests:
$ pytest tests/test_xarray_pickler.py::test_get_pickle_path
A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ git tag <tagname> $ git push origin <tagname>
Where the tag name is the raw version e.g. 0.1.0 GitHub Actions will then deploy to PyPI if tests pass.