Skip to content

Soften test/CI language and encourage asking for help#1273

Merged
danielfromearth merged 7 commits intomainfrom
docs/issue-525-soften-contributor-requirements-like-unit-tests
Mar 30, 2026
Merged

Soften test/CI language and encourage asking for help#1273
danielfromearth merged 7 commits intomainfrom
docs/issue-525-soften-contributor-requirements-like-unit-tests

Conversation

@danielfromearth
Copy link
Copy Markdown
Contributor

@danielfromearth danielfromearth commented Mar 26, 2026 •
edited
Loading

Description

Addresses #525

Softens contributing language around tests and CI to reduce barriers for new contributors. The key message is that tests are required before merge, not before opening a PR, and you don't have to write them alone.

Changes:

  • pull_request_template.md: Added inline encouragement to ask for help on the tests and CI checklist
    items; added "Need help?" block pointing to @earthaccess-dev/maintainers
  • pr-guide.md: Added welcoming info; replaced "run tests locally" steps
    with comfortable/not-comfortable paths; mentioned pre-commit.ci autofix inline
  • Contributor index.md: Added "New to contributing?", linking to PR guide and checklist

"Ready for review" checklist

  • Open PR as draft
  • Please review our Pull Request Guide
  • Mark "ready for review" after following instructions in the guide

Merge checklist

  • PR title is descriptive
  • PR body contains links to related and resolved issues (e.g. closes #1)
  • If needed, CHANGELOG.md updated (N/A)
  • If needed, docs and/or README.md updated
  • If needed, unit tests added (N/A)
  • All checks passing (comment pre-commit.ci autofix if pre-commit is failing)
  • At least one approval

@danielfromearth
docs(contributing): soften test/CI language and encourage asking for …
b83964d 
…help

- Rework PR template checklist to reassure contributors that asking for
  help with tests and CI failures is encouraged, not a blocker
- Add "Need help?" block to PR template, pointing to @maintainers
- Add welcoming info/tip to pr-guide.md and contributor index.md, clarifying tests are required before merge, not before opening a PR
- Replace "run tests locally" steps in bug fix and feature tabs with comfortable/not-comfortable paths
- Link pr-guide.md closing to the PR template
@danielfromearth danielfromearth linked an issue Mar 26, 2026 that may be closed by this pull request
"Soften" contributor requirements like unit tests #525
Closed
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 26, 2026 •
edited
Loading

Binder 👈 Launch a binder notebook on this branch for commit b83964d

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 0ac3c9e

Binder 👈 Launch a binder notebook on this branch for commit c3576fa

Binder 👈 Launch a binder notebook on this branch for commit 3662f67

Binder 👈 Launch a binder notebook on this branch for commit a60038c

Binder 👈 Launch a binder notebook on this branch for commit 9ab1618

Binder 👈 Launch a binder notebook on this branch for commit 62f3dcd

@danielfromearth danielfromearth added the impact: documentation Improvements or additions to documentation label Mar 26, 2026
@danielfromearth danielfromearth marked this pull request as ready for review March 26, 2026 16:37
@danielfromearth
Copy link
Copy Markdown
Contributor Author

danielfromearth commented Mar 26, 2026 •
edited
Loading

I noticed that the header ### Review contributing documentation in pr-guide.md on line 33 has a broken link also. I don't know where it is intended to be pointing though – it says contributor/index.md, but that's not a guide specific to contributing documentation. Perhaps it was meant to go to a page that hasn't yet been created?

Should it be removed?

mfisher87
mfisher87 reviewed Mar 26, 2026
View reviewed changes
Comment thread docs/contributor/index.md
mfisher87
mfisher87 reviewed Mar 26, 2026
View reviewed changes
Comment thread .github/pull_request_template.md Outdated
@danielfromearth danielfromearth self-assigned this Mar 27, 2026
chuckwondo
chuckwondo reviewed Mar 27, 2026
View reviewed changes
Comment thread .github/pull_request_template.md Outdated
chuckwondo
chuckwondo reviewed Mar 27, 2026
View reviewed changes
Comment thread .github/pull_request_template.md Outdated
danielfromearth and others added 2 commits March 27, 2026 13:37
@danielfromearth @chuckwondo @mfisher87
Avoid undefined acronyms, per code review
a60038c 
Co-authored-by: Chuck Daniels <cjdaniels4@gmail.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
@danielfromearth
Add CI explanation link to pull request template
9ab1618 
Updated the pull request template to clarify CI usage.
mfisher87
mfisher87 previously approved these changes Mar 27, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@mfisher87 mfisher87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice :)

chuckwondo
chuckwondo reviewed Mar 27, 2026
View reviewed changes
Comment thread .github/pull_request_template.md Outdated
@betolink
Copy link
Copy Markdown
Contributor

betolink commented Mar 30, 2026

@danielfromearth should we merge?

@danielfromearth danielfromearth merged commit 69e81d0 into main Mar 30, 2026
8 checks passed
@danielfromearth danielfromearth deleted the docs/issue-525-soften-contributor-requirements-like-unit-tests branch March 30, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chuckwondo chuckwondo chuckwondo left review comments

@mfisher87 mfisher87 mfisher87 approved these changes

@andypbarrett andypbarrett Awaiting requested review from andypbarrett

Assignees

@danielfromearth danielfromearth

Labels

impact: documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

"Soften" contributor requirements like unit tests

4 participants

@danielfromearth @betolink @mfisher87 @chuckwondo