explicit patch submission instructions #180
Merged
Conversation
This file contains 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
llrs
reviewed
Jul 29, 2024
| @@ -112,9 +112,24 @@ When creating a patch for submission, there are several things that you can do t | |||
|
|
|||
| ## Submitting your patch for review {#SubmitPatches} | |||
|
|
|||
| 1. Patch in response to a pre-existing issue or bug report: In this case, you should attach the patch to the existing issue or bug report on Bugzilla with a brief comment. | |||
| ### Patch in response to a pre-existing issue or bug report | |||
|
|
||
| ### Patch in response to an unreported issue or bug report | ||
|
|
||
| Assuming you already performed a search on Bugzilla for a pre-existing issue or bug and did not find the issue or bug reported, you need to create a new bug report and include your patch with it. Please fill in as much relevant detail as possible to prevent reviewers from having to delay reviewing your patch because of lack of information. Include (mostly as the first sentence), a to-the-point explanation of what the purpose of the patch is. This sentence should not be in the descriptive form, rather an imperative form will be more suitable here. If this is not enough detail for a patch, a new paragraphs(s) can be added to explain in proper depth what has happened. The details should be good enough that a core developer reading it understands the justification for the change. |
There was a problem hiding this comment.
This paragraph was moved from above, but I think we can improve it too in this PR (feel free to ignore the comments):
- Split each sentence in a different line: this will help future diffs to a single sentence.
- The content is related to other sections of the book, I would add links to them:
a) To search on Bugzilla (section 3.3)
b) How to report a bug (Chapter 4)
c) How to write a good patch (7.4)
Reconsidering, perhaps splitting this in two sections complicates following the book. Adding a sentence at the end of the "Submitting your patch for review" section highlighting the differences on this PR (without the new third level section) and if it is all in one (open bug report+patch) might be easier...
What do you think?
SaranjeetKaur
approved these changes
Aug 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
closes #177