Skip to content

docs: add example bugfix and feature PRs to contributor guide #1328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tmchow wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add example bugfix and feature PRs to contributor guide #1328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ and this project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html)

## [Unreleased]

- Add example bugfix and feature PR links to the contributor PR guide ([#530](https://github.com/earthaccess-dev/earthaccess/issues/530))
- Allow for granule search for collection without SpatialExtent information ([@lsterzinger](https://github.com/lsterzinger))

### Changed
Expand Down
2 changes: 2 additions & 0 deletions docs/contributor/pr-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ relevant tab to proceed.
- Create a branch to resolve your issue
- Update the relevant code to fix the issue
- If you're comfortable writing tests: create one or more new tests to demonstrate the bug, verify they fail before your fix, and pass after. It's fine to let PR CI/CD run the tests for you instead of running them locally.
[PR #923](https://github.com/earthaccess-dev/earthaccess/pull/923) is a small example: it fixes two `open_virtual_dataset` bugs and adds tests in `tests/integration/test_virtualizarr.py` that fail before the fix and pass after.
- If you're **not** comfortable writing tests: that's OK! Open your PR anyway and note that you'd like help with tests. We'll work with you to get them added before merging.
- Lint and format your code with [pre-commit](development.md#usage-of-pre-commit) (or comment `pre-commit.ci autofix` on your PR to have it done automatically)
- Describe your changes in the `CHANGELOG.md`
Expand All @@ -104,6 +105,7 @@ relevant tab to proceed.
- Create a branch for your new feature in your fork
- Write the code to implement your new feature in a backwards compatible manner. If breaking changes are necessary, discuss your strategy with the team first.
- If you're comfortable writing tests: create at least one test that exercises your feature. It's fine to let PR CI/CD run the test suite for you instead of running it locally.
[PR #1146](https://github.com/earthaccess-dev/earthaccess/pull/1146) is a small example: it adds the `LARC_CLOUD` provider to `daac_list` and adds an integration test that exercises it.
- If you're **not** comfortable writing tests: that's OK! Open your PR anyway and note that you'd like help with tests. We'll work with you to get them added before merging.
- Lint and format your code with [pre-commit](development.md#usage-of-pre-commit) (or comment `pre-commit.ci autofix` on your PR to have it done automatically)
- Describe your changes in the `CHANGELOG.md`
Expand Down
Loading