docs(contributing): add base-branch callout so PRs target dev - #240
Merged
Conversation
Both LFDT mentee PRs in this cohort (#232, #237) opened against `main` instead of `dev`. The rule was in CONTRIBUTING.md but buried as one bullet inside "Submitting a PR" alongside Conventional Commits and lint. Mentees who skim only the PR template never saw it. Two adds: 1. Callout block at the top of CONTRIBUTING.md (GitHub-flavoured `> [!IMPORTANT]` admonition) so it appears between the doc heading and Quick Start, and shows a starter command for branching off dev. 2. New first checklist item in PULL_REQUEST_TEMPLATE.md: "Base branch is `dev`, not `main`" linking back to CONTRIBUTING.md. This is the one a contributor actually sees in the PR compose form. No code change.
Issues (must fix)
Heads up
Please update your PR to address these points. |
|
This PR has been automatically marked as stale because it has not had activity in the last 14 days. It will be closed in 7 days if no further activity occurs. If you're still working on this, please push an update or leave a comment. |
|
Closing due to inactivity. If you'd like to continue, please open a new PR. |
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.
What this changes
Both LFDT mentee PRs in this cohort (#232, #237) opened against
maininstead ofdev. The dev-vs-main rule was inCONTRIBUTING.mdbut buried as one bullet inside "Submitting a PR" alongside Conventional Commits and lint. A skim of the PR template missed it entirely.Two surgical adds:
CONTRIBUTING.md: a GitHub-flavoured> [!IMPORTANT]admonition right after the doc heading, before Quick Start. Includes the starter command for branching offdev..github/PULL_REQUEST_TEMPLATE.md: "Base branch isdev, notmain" with a link back to CONTRIBUTING.md. This is the one a contributor sees in the PR compose form before they hit submit.No code change. No test impact.
How to test
Visual review: the callout renders correctly on github.com (GitHub admonition syntax). The PR template change appears in the compose form for the next PR.