-
Notifications
You must be signed in to change notification settings - Fork 721
Enhance "Making your PR Merge Worthy" section #3028
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pkingstonxyz
wants to merge
9
commits into
ansible:devel
Choose a base branch
from
pkingstonxyz:fix-contribution-guide
base: devel
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
9a4a65c
Fix grammar and add documentation link
pkingstonxyz 4949c24
Add small section on testing
pkingstonxyz 14eb9be
Edit title for Changelog section
pkingstonxyz 1e13435
Update title of test section and reorganize sentences
pkingstonxyz 25e68a1
Fix spelling of preferred
pkingstonxyz 14b315d
Add words for clarity
pkingstonxyz 3a2fcd4
Capitalize YAML and RST
pkingstonxyz d799294
Fix line breaks in test section
pkingstonxyz 3bd94fc
Rephrase testing section
pkingstonxyz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if tests are required per any official policy, or if there is any
nuance for things that shouldn't include tests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think cases where tests aren't necessary are obvious to contributors (like sending in a typo fix). We probably shouldn't give them any idea along the lines of "by hey, you can actually ignore this requirement". They'll ask if unsure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm okay, I've rephrased to be more ambiguous but I think a call out to "Hey tests are good" should be included for first time contributors especially.