docs: restructure DCO guidance into scannable subsection - #3346
Closed
cameronhotchkies wants to merge 1 commit into
Closed
docs: restructure DCO guidance into scannable subsection#3346cameronhotchkies wants to merge 1 commit into
cameronhotchkies wants to merge 1 commit into
Conversation
Extracts the dense DCO paragraph into a dedicated '### Sign Your Commits' subsection with a command-first layout: the command block leads, then a plain-English explainer, then fix and auto-setup sub-blocks. Content is unchanged; only structure and readability are improved. Co-authored-by: Cameron Hotchkies <chotchkies@block.xyz> Signed-off-by: Cameron Hotchkies <chotchkies@block.xyz>
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.
Extracts the dense inline DCO paragraph from the "Before You Open a PR" section into a dedicated
### Sign Your Commitssubsection.What changed
### Sign Your Commitsheading directly below the Conventional Commits paragraphgit commit -s) in a code block#### Fix unsigned commits already pushedand#### Auto-setup for future commitssubheadingsWhy
Open PRs are getting blocked on DCO checks. The existing guidance was buried mid-paragraph; contributors may not find it until CI blocks them. This makes the requirement and its fix immediately visible and actionable.
Notes
Docs-only change, no code modified. Replaces closed PR #3337, which GitHub would not reopen after the branch was force-pushed.