Contributing¶
Version 3.3.7 for CF-1.11
Reporting bugs¶
Please report bugs via a new issue in issue tracker (https://github.com/NCAS-CMS/cfunits/issues), using the Bug report issue template.
Feature requests and suggested improvements¶
Suggestions for new features and any improvements to the functionality, API, documentation and infrastructure can be submitted via a new issue in issue tracker (https://github.com/NCAS-CMS/cfunits/issues), using the Feature request issue template.
Questions¶
Questions, such as “how can I do this?”, “why does it behave like that?”, “how can I make it faster?”, etc., can be raised via a new issue in issue tracker (https://github.com/NCAS-CMS/cfunits/issues), using the Question issue template.
Preparing pull requests¶
Pull requests should follow on from a discussion in the issue tracker (https://github.com/NCAS-CMS/cfunits/issues).
Fork the cfunits GitHub repository (https://github.com/NCAS-CMS/cfunits).
Note
The cfunits GitHub repository uses main as the name of its
default branch, so you must refer to main when you need to
reference the default branch. It is useful to use this as the
name of the default branch on your fork, too.
Clone your fork locally and create a branch:
$ git clone git@github.com:<YOUR GITHUB USERNAME>/cfunits.git
$ cd cfunits
$ git checkout -b <your-bugfix-feature-branch-name>
Break your edits up into reasonably-sized commits, each representing a single logical change:
$ git commit -a -m "<COMMIT MESSAGE>"
Create a new changelog entry in Changelog.rst. The entry should be
written (where <description> should be a brief description of
the change) as:
* <description> (https://github.com/NCAS-CMS/cfunits/issues/<issue number>)
Run the test suite to make sure the tests all pass:
$ cd cfunits/test
$ python run_tests.py
Add your name to the list of contributors list at
docs/source/contributing.rst.
Finally, make sure all commits have been pushed to the remote copy of
your fork and submit the pull request via the GitHub website, to the
main branch of the NCAS-CMS/cfunits repository. Make sure to
reference the original issue in the pull request’s description.
Note that you can create the pull request while you’re working on this, as it will automatically update as you add more commits. If it is a work in progress, you can mark it initially as a draft pull request.
Contributors¶
We would like to acknowledge and thank all those who have contributed ideas, code, and documentation to the cfunits library:
Daniel Mohr
David Hassell
Gareth Jones
Jonathan Gregory
Lars Bärring
Sadie Bartholomew