Skip to content

Contributing guide enhancements #210

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 4 commits into from
Nov 13, 2025
Merged

Contributing guide enhancements #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
67467e5
Mention code of coduct in contributing
lukehoffmann Nov 12, 2025
9877825
Describe zenodo process in contributing.md
lukehoffmann Nov 12, 2025
f8256b4
Add myself to zenodo list
lukehoffmann Nov 12, 2025
de540ac
Use full URLs for links
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
5 changes: 5 additions & 0 deletions .zenodo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@
"orcid": "https://orcid.org/0009-0004-5881-0695",
"affiliation": "ACCESS-NRI, Australia",
"name": "Yang, Edward"
},
{
"orcid": "https://orcid.org/0009-0006-3272-3678",
"affiliation": "Bureau of Meteorology, Australia",
"name": "Hoffmann, Luke"
}
],
"license": "Apache-2.0",
Expand Down
16 changes: 16 additions & 0 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ If you are thinking about contributing some code to PyEarthTools, you are very w

[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.

## Code of Conduct

Please review our [Code of Conduct](https://github.com/ACCESS-Community-Hub/PyEarthTools/blob/develop/CODE_OF_CONDUCT.md) before contributing and help us create a welcoming and safe environment for everyone.

## Getting Started

Expand All @@ -25,3 +28,16 @@ Details of the contribution workflow can be found in the [Developer Guide](https
- Code reviews
- Coding formatting and test coverage requirements
- GitHub actions


## Contributor Recognition in Zenodo

When we release a new version of PyEarthTools, that version is archived on Zenodo. See: https://doi.org/10.5281/zenodo.15760768

Once you have contributed to PyEarthtools, you may like to be listed on Zenodo as an author the next time PyEarthTools is archived. If so, add your details to [`.zenodo.json`](https://github.com/ACCESS-Community-Hub/PyEarthTools/blob/develop/.zenodo.json), at the bottom of the “creators” section. The fields you will need to complete are:

1. “orcid”. This is an optional field. If you don’t have an ORCID, but would like one, you can obtain one here: https://info.orcid.org/researchers/ .
2. “affiliation”. Options include: the institution you are affiliated with, “Independent Researcher” or “Independent Contributor”.
3. “name”. Format: surname, given name(s).

Submit this change, either as a new pull request or as part of another pull request you may be submitting.