Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (25 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

29 lines (25 loc) · 3.26 KB
Raw

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:

  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.