docs: add example bugfix and feature PRs to contributor guide#1328
Open
tmchow wants to merge 1 commit into
Open
docs: add example bugfix and feature PRs to contributor guide#1328tmchow wants to merge 1 commit into
tmchow wants to merge 1 commit into
Conversation
Closes earthaccess-dev#530. Per the issue, link concrete small example PRs to the "create one or more new tests to demonstrate the bug" and "create at least one test that exercises your feature" bullets so newer contributors can see what a small, scoped, test-bearing PR looks like. Bug-fix example: PR earthaccess-dev#923 (open_virtual_dataset bugs, +62 lines, adds tests in tests/integration/test_virtualizarr.py). Feature example: PR earthaccess-dev#1146 (LARC_CLOUD provider in daac_list, +14 lines, adds an integration test).
|
I will automatically update this comment whenever this PR is modified |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds two concrete example-PR links to
docs/contributor/pr-guide.md, one under the "Fixing an Issue or Bug" path and one under "Contributing a New Feature". Both bullets are right where the issue asks ("at or near where we currently say 'create one or more new tests to demonstrate the bug' and 'create at least one test that exercises your feature'").Examples picked
Both are recently merged, small, explainable, and include unit/integration tests (the issue's three criteria).
Fix small open_virtual_dataset bugs. +62 lines across 5 files, adds tests intests/integration/test_virtualizarr.pythat fail before the fix and pass after.Add LARC_CLOUD provider to daac_list. +14 lines across 2 files, adds an integration test intests/integration/test_cloud_download.pythat exercises the new provider.Files changed
docs/contributor/pr-guide.md(+2 lines)CHANGELOG.md(+1 line under[Unreleased])Closes #530
📚 Documentation preview 📚: https://earthaccess--1328.org.readthedocs.build/en/1328/