Skip to content

Latest commit

 

History

History
89 lines (56 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

89 lines (56 loc) · 3.64 KB
Raw

Contributing

Thank you for your interest in helping make custom on-demand SAR processing accessible!

We're excited you would like to contribute to HyP3! Whether you're finding bugs, adding new features, fixing anything broken, or improving documentation, get started by submitting an issue or pull request!

Submitting an Issue

If you have any questions or ideas, or notice any problems or bugs, first search open issues to see if the issue has already been submitted. We may already be working on the issue. If you think your issue is new, you're welcome to create a new issue.

Pull Requests are welcome

Found a typo, know how to fix a bug, want to update the docs, want to add a new feature? Great!

The smaller the PR, the easier it is to review and test and the more likely it is to be successful.

For major contributions, consider opening an issue describing the contribution so we can help guide and breakup the work into digestible pieces.

Workflow

If you want to submit your own contributions, please use a forking workflow.

The basic steps are:

  1. Fork the repository:

    fork button

    Note: if you work at ASF, you can use the asfadmin fork

  2. Clone your fork

    git clone https://github.com/[OWNER]/hyp3-lib.git

  3. Add this repository as an upstream remote

    git remote add upstream https://github.com/ASFHyP3/hyp3-lib.git

  4. Create a feature branch based on the upstream/develop branch

    git fetch --all --prune
git checkout --no-track -b [NAME] upstream/develop

  5. Make your changes! Then push them to your fork

    git push -u origin [NAME]

  6. Propose your changes by opening a pull request to ASFHyP3/hyp3-lib's develop branch

    pr button

    pr base selection

Guidelines

We ask that you follow these guidelines with your contributions

Style

We generally follow python community standards (PEP8), except we allow line lengths up to 120 characters. We recommend trying to keep lines 80--100 characters long, but allow up to 120 when it improves readability.

Documentation

We are working to improve our documentation!

For all public-facing functions/methods (not marked internal use), please include type hints (when reasonable) and a docstring formatted Google style.

Tests

All of the automated tests for this project need to pass before your submission will be accepted.

If you add new functionality, please consider adding tests for that functionality as well.

Commits

  • Make small commits that show the individual changes you are making
  • Write descriptive commit messages that explain your changes

Example of a good commit message;

Improve contributing guidelines. Fixes #10

Improve contributing docs and consolidate them in the standard location
https://help.github.com/articles/setting-guidelines-for-repository-contributors/

Changelog

Changes should be documented in the ## [Unreleased] section of the CHANGELOG.md. The format should follow this standard.