From 0b95c12dd41083a5ee6905b50ecfaa62a23b3397 Mon Sep 17 00:00:00 2001 From: Luke Hoffmann Date: Wed, 12 Nov 2025 10:43:28 +1100 Subject: [PATCH 1/5] Add top-level contributing guide --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ docs/devguide.md | 2 +- 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c1327c26 --- /dev/null +++ b/CONTRIBUTING.md @@ -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: 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](docs/devguide.md), 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 diff --git a/docs/devguide.md b/docs/devguide.md index d459cc08..d4be6acc 100644 --- a/docs/devguide.md +++ b/docs/devguide.md @@ -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: From 45621bfcb67ed6695745dc0dd038b707f9c23b00 Mon Sep 17 00:00:00 2001 From: Luke Hoffmann Date: Wed, 12 Nov 2025 11:10:48 +1100 Subject: [PATCH 2/5] Link to readthedocs --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1327c26..6b33ac0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ If you think you may want to contribute code, you will need to follow the PyEart ## Contribution Workflow -Details of the contribution workflow can be found in the [Developer Guide](docs/devguide.md), including +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, From 08e30bf0c49e8db3b61ae83309f088296407026b Mon Sep 17 00:00:00 2001 From: Luke Hoffmann Date: Wed, 12 Nov 2025 11:18:23 +1100 Subject: [PATCH 3/5] Fix markdown link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b33ac0f..40db39fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ If you are thinking about contributing some code to PyEarthTools, you are very w - 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. +[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 From 542699d19e0c4e43eac91111c06d7d7c6a3c595e Mon Sep 17 00:00:00 2001 From: Luke Hoffmann Date: Wed, 12 Nov 2025 11:44:41 +1100 Subject: [PATCH 4/5] More hyperlinks --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 40db39fc..df6e8b9e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,9 +11,9 @@ If you are thinking about contributing some code to PyEarthTools, you are very w ## Getting Started -To learn more about PyEarthTools in general, a good place to start is: https://pyearthtools.readthedocs.io/en/latest/newuser.html +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 . +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 From 3ce57d4d2577d546c537de1c5a3b18da508c7848 Mon Sep 17 00:00:00 2001 From: Luke Hoffmann Date: Wed, 12 Nov 2025 12:02:12 +1100 Subject: [PATCH 5/5] Move contributing into docs directory --- CONTRIBUTING.md => docs/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename CONTRIBUTING.md => docs/contributing.md (98%) diff --git a/CONTRIBUTING.md b/docs/contributing.md similarity index 98% rename from CONTRIBUTING.md rename to docs/contributing.md index df6e8b9e..673c0950 100644 --- a/CONTRIBUTING.md +++ b/docs/contributing.md @@ -11,7 +11,7 @@ If you are thinking about contributing some code to PyEarthTools, you are very w ## 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) +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) .