This repository contains open source software developed and maintained by [HPSC TerrSys].

Contributions are welcome! First and foremost, contributions are subject to the [Contributor Code of Conduct] and we do our best to adhere to them. If that sounds reasonable to you, you can start contributing in two ways:

1. **Asking questions or reporting problems via the [issue tracker]**. Browse through open issues to get ideas on how they are typically written up. We appreciate well-written issues that follow these guidelines:
    - [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html)
    - [How to Ask Questions the Smart Way](https://www.catb.org/esr/faqs/smart-questions.html#beprecise)

2. **Modify the documentation or code**. Proposed changes must be linked to an open issue (see previous item) and go through the standard [Github pull request] process, which is explained below in brief:
    1. [Fork] this repo and then [clone] it to your local PC.
    2. [Create a branch]. This branch will contain your proposed fixes/features.
    3. Make changes on your branch, and then regularly [commit] and [push] changes. Also, write good `git commit` messages: a good one answers the question "what is the most interesting aspect of this commit?" in as few words as possible.
    4. When you're ready to share your fixes/new feature, [create a pull request (PR)]. Mark it as a [draft] if you intend to keep working on it; a draft PR is also a good time to get early feedback from your work.
    5. Mark your PR as _Ready_ to start the review process. Wait for the maintainers to provide comments, and then address their review comments as they come.
    6. Changes will be accepted if it **(1)** passes all automated tests and **(2)** at least one maintainer approved the PR.
    7. **Optional**: Attach experimental results in the PR discussion (see [example here]). Well-documented PRs are highly appreciated and are more likely to get accepted.

[HPSC TerrSys]: https://github.com/HPSCTerrSys?view_as=public
[Contributor Code of Conduct]: https://www.contributor-covenant.org/version/3/0/code_of_conduct
[issue tracker]: https://github.com/HPSCTerrSys/eCLM/issues
[Github pull request]: https://docs.github.com/en/pull-requests/reference/pull-requests
[Fork]: https://docs.github.com/en/pull-requests/how-tos/work-with-forks/fork-a-repo?versionId=free-pro-team%40latest&productId=pull-requests&restPage=reference%2Cpull-requests&search-overlay-input=branch&search-overlay-ask-ai=true#forking-a-repository
[clone]: https://docs.github.com/en/pull-requests/how-tos/work-with-forks/fork-a-repo?versionId=free-pro-team%40latest&productId=pull-requests&restPage=reference%2Cpull-requests&search-overlay-input=branch&search-overlay-ask-ai=true#cloning-your-forked-repository
[Create a branch]: https://docs.github.com/en/pull-requests/how-tos/commit-changes/managing-branches-within-your-repository#creating-a-branch
[commit]: https://github.com/git-guides/git-commit
[push]: https://github.com/git-guides/git-push
[Create a pull request (PR)]: https://docs.github.com/en/pull-requests/how-tos/create-pull-requests/creating-a-pull-request-from-a-fork
[draft]: https://docs.github.com/en/pull-requests/reference/pull-requests#draft-pull-requests
[example here]: https://github.com/HPSCTerrSys/eCLM/pull/101