forked from mdekauwe/CABLE_benchmarking
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
64 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Contributing guidelines | ||
|
||
:tada: **First off, thank you for considering contributing to our project!** :tada: | ||
|
||
This is a community-driven project, so it's people like you that make it useful and | ||
successful. | ||
These are some of the ways to contribute: | ||
|
||
* Submitting bug reports and feature requests | ||
* Fixing typos and improving the documentation | ||
* Writing code for everyone to use | ||
|
||
## Ground rules | ||
|
||
The goal is to maintain a diverse community that's pleasant for everyone. **Please be considerate and respectful of others.** | ||
|
||
## Quick links | ||
|
||
* [Contributors Guide](https://benchcab.readthedocs.io/en/latest/dev_guide/contributing/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Contributors Guide | ||
|
||
## Ways to contribute | ||
|
||
We welcome a range of contributions to this open-source software: | ||
|
||
- open or contribute to [a GitHub issue][benchcab_issues] to convey a problem or send a bug report or propose an enhancement | ||
- update the documentation to fix a typo, improve the clarity or the readability, add missing sections, etc. | ||
- contribute to the code to fix an open issue. | ||
|
||
_Before_ contributing to the documentation or the code-base, consider becoming a member of the CABLE-LSM GitHub organisation. Doing so allows you to create a branch within the `benchcab` repository instead of working from a fork which simplifies the contribution process. To request an invitation to the organisation please [open an issue][new_issue] on the `benchcab` repository. | ||
|
||
## Contributing documentation | ||
|
||
The documentation is written in Markdown using [Material for Mkdocs][Material] and distributed through [ReadTheDocs][ReadTheDocs]. | ||
The `benchcab` repository has continuous integration set up to build a preview of the documentation for all pull requests which means you are not required to build the documentation locally. | ||
|
||
If you would like to build the documentation locally, you can use the [`pip` requirements file][mkdocs-requirements] to install all the required packages. Once the packages are installed, you can use `mkdocs serve` from the top level of the `benchcab` repository to build a local version. | ||
|
||
## Contributing code | ||
|
||
`benchcab` is written in python 3. It is using the following packages and standards for formatting: | ||
|
||
- [flake8][flake8] for linting | ||
- [black][black] for code formatting | ||
|
||
`benchcab` supports the stable Python versions. It should not contain features from pre-release versions. All contributions to `benchcab` should follow the ACCESS-NRI [Coding guidelines for Python][code_guidelines]. | ||
|
||
### Testing | ||
You can use this [conda environment file][benchcab-dev] to install a development environment to test your changes locally. | ||
|
||
`benchcab` comes with a suite of unit tests written in the [`pytest`][pytest] framework. New contributions to the code base are expected to update the tests as required. | ||
|
||
[Material]: https://squidfunk.github.io/mkdocs-material/ | ||
[ReadTheDocs]: https://about.readthedocs.com/ | ||
[mkdocs-requirements]: https://github.com/CABLE-LSM/benchcab/blob/master/mkdocs-requirements.txt | ||
[new_issue]: https://github.com/CABLE-LSM/benchcab/issues/new | ||
[benchcab_issues]: https://github.com/CABLE-LSM/benchcab/issues/ | ||
[benchcab-dev]: https://github.com/CABLE-LSM/benchcab/blob/master/.conda/benchcab-dev.yaml | ||
[flake8]: https://flake8.pycqa.org/en/latest/ | ||
[black]: https://pypi.org/project/black/ | ||
[code_guidelines]: https://github.com/ACCESS-NRI/dev-docs/wiki/Code-guidelines#python | ||
[pytest]: https://docs.pytest.org/en/7.3.x/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters