Skip to content

Add CONTRIBUTING.md #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tennlee merged 5 commits into from
Nov 12, 2025
Merged

Add CONTRIBUTING.md #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0b95c12
Add top-level contributing guide
lukehoffmann Nov 11, 2025
45621bf
Link to readthedocs
lukehoffmann Nov 12, 2025
08e30bf
Fix markdown link
lukehoffmann Nov 12, 2025
542699d
More hyperlinks
lukehoffmann Nov 12, 2025
3ce57d4
Move contributing into docs directory
lukehoffmann Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# How to Contribe to PyEarthTools

If you are thinking about contributing some code to PyEarthTools, you are very welcome. There are many ways you can help to improve PyEarthTools, for example

- Raise bugs and feature requests in the [GitHub issue tracker](https://github.com/ACCESS-Community-Hub/PyEarthTools/issues)
- Improve documentation and tutorials based on your own experience
- Contribute to code quality and test coverage

[A pinned issue](https://github.com/ACCESS-Community-Hub/PyEarthTools/issues/174) contains a non-exhaustive list of things you could consider doing. Alternatively, you are very welcome to look through the GitHub issue tracker and see if there is anything that grabs your interest. If you are going to work on an issue, let me know so we can avoid people doubling up.


## Getting Started

To learn more about PyEarthTools in general, a good place to start is the [New Users Guide](https://pyearthtools.readthedocs.io/en/latest/newuser.html) .

If you think you may want to contribute code, you will need to follow the PyEarthTools installation instructions [here](https://pyearthtools.readthedocs.io/en/latest/installation.html#developer-installation) and read the developer guide [here](https://pyearthtools.readthedocs.io/en/latest/devguide.html) .


## Contribution Workflow

Details of the contribution workflow can be found in the [Developer Guide](https://pyearthtools.readthedocs.io/en/latest/devguide.html), including

- Forking the repository in GitHub,
- Submitting changes via pull requests from your own fork,
- Code reviews
- Coding formatting and test coverage requirements
- GitHub actions
2 changes: 1 addition & 1 deletion docs/devguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This is a summary only, and should be expanded to provide more detail. This is i
- Pylint checking is a good idea, please turn it on and do your best.


## Creating Your Own Fork of PyEarthTools for the First Time
## Creating Your Own Fork of PyEarthTools for the First Time

Unless you are an advanced Git user, we would recommend you follow this process:

Expand Down