Contributing to the FEISTY model

Contributing to the FEISTY model#

Contributions are highly welcomed and appreciated.

The following sections cover some general guidelines regarding development in feisty 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.

Developing FEISTY#

The best approach to contributing to the FEISTY code or documentation is to fork the repository, clone your fork locally, apply your edits, push back to your fork, then submit a pull request on GitHub.

Here are some detailed instructions describing these steps.

  1. Fork the feisty GitHub repository. It’s fine to use feisty as your fork repository name because it will live under your user.

  2. Clone your fork locally using git and create a branch:

    $ git clone git@github.com:YOUR_GITHUB_USERNAME/feisty.git
$ cd feisty

  3. Consider creating your own branch off “main”:

    $ git checkout -b your-bugfix-feature-branch-name main

  4. Install pre-commit and its hook on the feisty repo:

    $ pip install --user pre-commit
$ pre-commit install

    Afterwards pre-commit will run whenever you commit.

    https://pre-commit.com/ is a framework for managing and maintaining multi-language pre-commit hooks to ensure code-style and code formatting is consistent.

  5. Install dependencies into a new conda environment:

    $ conda env update -f ci/environment.yml

  6. Run all the tests

    Now running tests is as simple as issuing this command:

    $ conda activate sandbox-devel
$ pytest --junitxml=test-reports/junit.xml --cov=./ --verbose

    This command will run tests via the “pytest” tool against the latest Python version.

  7. You can now edit your local working copy and run the tests again as necessary. Please follow PEP-8 for naming.

    When committing, pre-commit will re-format the files if necessary.

  8. Commit and push once your tests pass and you are happy with your change(s):

    $ git commit -a -m "<commit message>"
$ git push -u

  9. Finally, submit a pull request through the GitHub website using this data:

    head-fork: YOUR_GITHUB_USERNAME/feisty
compare: your-branch-name

base-fork: NCAR/feisty
base: master

Write documentation#

Documentation is critical to enabling a robust, usable code base. Documentation files are is in the docs/ directory and are built with the Jupyter Book utility. Documentation files can be Jupyter Notebooks, MyST Markdown, or reStructuredText. The layout of the documentation is expressed in docs/_toc.yml.

Documentation is built automatically using GitHub Actions.

You can edit documentation files directly in the GitHub web interface, without using a local copy. This can be convenient for small fixes.

Note

Build the documentation locally with the following command:

$ conda env update -f ci/environment.yml
$  jupyter-book build docs/ --all

The built documentation should be available in the docs/_build/ and can be viewed using a local browser at:

file:///path/to/feisty/docs/_build/html/index.html

Feature requests and feedback#

Feature requests, bug reports and questions can be submitted via the GitHub issue tracker.

Contents