Skip to content

Link example bug-fix and feature PRs in PR guide - #1329

Draft
mvanhorn wants to merge 1 commit into
earthaccess-dev:mainfrom
mvanhorn:mvanhorn/issue-530-example-prs
Draft

Link example bug-fix and feature PRs in PR guide#1329
mvanhorn wants to merge 1 commit into
earthaccess-dev:mainfrom
mvanhorn:mvanhorn/issue-530-example-prs

Conversation

@mvanhorn

@mvanhorn mvanhorn commented May 5, 2026

Copy link
Copy Markdown
Contributor

Closes #530

What this PR does

Adds a sub-bullet under each "If you're comfortable writing tests" checkpoint in docs/contributor/pr-guide.md, pointing at a representative merged PR with covering tests:

  • The "Fixing an Issue or Bug" tab now links to #1015 (method-resolution fix with new unit and integration tests).
  • The "Contributing a New Feature" tab now links to #1198 (force keyword + temporary-filename behavior on download() with new unit and integration tests).

Why these PRs

The issue asks for examples that are small, explainable, and include unit tests. Both linked PRs:

Notes

  • Per the PR guide's own rule ("docs changes don't need a changelog entry"), no CHANGELOG.md change is included.
  • The new sub-bullets are nested under the existing "If you're comfortable writing tests" lines so they sit at the spot the issue called out, without disturbing the surrounding flow or the parallel "if you're not comfortable" guidance below.

📚 Documentation preview 📚: https://earthaccess--1329.org.readthedocs.build/en/1329/

@github-actions

github-actions Bot commented May 5, 2026

Copy link
Copy Markdown

Binder 👈 Launch a binder notebook on this branch for commit 148b7ee

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 6db69ca

Closes earthaccess-dev#530

Adds a sub-bullet under each "If you're comfortable writing tests"
checkpoint in docs/contributor/pr-guide.md pointing at a representative
merged PR with covering tests:

- Bug-fix tab links earthaccess-dev#1015 (method resolution fix with unit + integration tests)
- New-feature tab links earthaccess-dev#1198 (download() force/temp-name with unit + integration tests)

Both PRs are small, single-purpose, and include new tests, matching the
criteria in the issue.
@mvanhorn
mvanhorn force-pushed the mvanhorn/issue-530-example-prs branch from 148b7ee to 6db69ca Compare August 6, 2026 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add example bug / feature pull requests to contributing docs

1 participant