Interested in helping build intake-esm? Have code from your work that you believe others will find useful? Have a few minutes to tackle an issue?
Contributions are highly welcomed and appreciated. Every little help counts, so do not hesitate!
The following sections cover some general guidelines regarding development in intake-esm for maintainers and contributors. Nothing here is set in stone and can't be changed. Feel free to suggest improvements or changes in the workflow.
We'd also like to hear about your propositions and suggestions. Feel free to submit them as issues on intake-esm's GitHub issue tracker and:
- Explain in detail how they should work.
- Keep the scope as narrow as possible. This will make it easier to implement.
Report bugs for intake-esm in the issue tracker.
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, specifically the Python interpreter version, installed libraries, and intake-esm version.
- Detailed steps to reproduce the bug.
If you can write a demonstration test that currently fails but should pass (xfail), that is a very useful commit to make as well, even if you cannot fix the bug itself.
Look through the GitHub issues for bugs.
Talk to developers to find out how you can fix specific bugs.
intake-esm could always use more documentation. What exactly is needed?
- More complementary documentation. Have you perhaps found something unclear?
- Docstrings. There can never be too many of them.
- Blog posts, articles and such -- they're all very appreciated.
You can also edit documentation files directly in the GitHub web interface, without using a local copy. This can be convenient for small fixes.
To build the docs locally, follow the steps 1 and 2 under Preparing Pull Requests below and then create a conda environment and build the docs with the following commands:
$ conda env update -f ci/environment-docs.yml
$ conda activate intake-esm-doc
$ make docs-
Fork the intake-esm GitHub repository.
-
Clone your fork locally using git, connect your repository to the upstream (main project), and create a branch::
$ git clone [email protected]:YOUR_GITHUB_USERNAME/intake-esm.git $ cd intake-esm $ git remote add upstream [email protected]:intake/intake-esm.git
now, to fix a bug or add feature create your own branch off "main":
$ git checkout -b your-bugfix-feature-branch-name main
If you need some help with Git, follow this quick start guide: https://docs.github.com/en/get-started/getting-started-with-git
-
Install dependencies into a new conda environment::
$ conda env update -f ci/environment.yml $ conda activate intake-esm-dev
-
Make an editable install of intake-esm by running::
$ python -m pip install -e . -
Install pre-commit hooks on the intake-esm repo::
$ pre-commit install
Afterwards
pre-commitwill run whenever you commit.pre-commitis a framework for managing and maintaining multi-language pre-commit hooks to ensure code-style and code formatting is consistent.Now you have an environment called
intake-esm-devthat you can work in. You’ll need to make sure to activate that environment next time you want to use it after closing the terminal or your system. -
(Optional) Run all the tests
Now running tests is as simple as issuing this command::
$ pytest --cov=./
This command will run tests via the
pytesttool. -
Commit and push once your tests pass and you are happy with your change(s)::
When committing,
pre-commitwill re-format the files if necessary.$ git commit -a -m "<commit message>" $ git push -u -
Finally, submit a pull request through the GitHub website using this data::
head-fork: YOUR_GITHUB_USERNAME/intake-esm compare: your-branch-name base-fork: intake/intake-esm base: main # if it's a bugfix or feature