diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 00000000..673c0950 --- /dev/null +++ b/docs/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 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 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: