[improve][doc] Clarify to check numbering when creating the PIP doc #21623
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
|
@asafm Please add the following content to your PR description and select a checkbox: |
|
@asafm Please select only one documentation label in your PR description. |
poorbarcode
approved these changes
Nov 27, 2023
pip/README.md
Outdated
| @@ -69,7 +69,8 @@ The process works in the following way: | |||
| 3. Write the proposal following the section outlined by the template and the explanation for each section in the comment it contains (you can delete the comment once done). | |||
| * If you need diagrams, avoid attaching large files. You can use [MermaidJS](https://mermaid.js.org/) as simple language to describe many types of diagrams. | |||
| 4. Create GitHub Pull request (PR). The PR title should be `[improve][pip] PIP-xxx: {title}`, where the `xxx` match the number given in previous step (file-name). Replace `{title}` with a short title to your proposal. | |||
| 5. The author(s) will email the [email protected] mailing list to kick off a discussion, using subject prefix `[DISCUSS] PIP-xxx: {PIP TITLE}`. The discussion will happen in broader context either on the mailing list or as general comments on the PR. Many of the discussion items will be on particular aspect of the proposal, hence they should be as comments in the PR to specific lines in the proposal file. | |||
| *Validate* again that your numer does not collide, by step (2) numbering check. | |||
| 6. The author(s) will email the [email protected] mailing list to kick off a discussion, using subject prefix `[DISCUSS] PIP-xxx: {PIP TITLE}`. The discussion will happen in broader context either on the mailing list or as general comments on the PR. Many of the discussion items will be on particular aspect of the proposal, hence they should be as comments in the PR to specific lines in the proposal file. | |||
There was a problem hiding this comment.
The No. of this line should be 5, right?
RobertIndie
approved these changes
Nov 27, 2023
joeCarf
approved these changes
Nov 27, 2023
Technoboy-
added
doc-not-needed
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.
Motivation
When someone writes a PIP they choose the number before starting the doc, but time does pass until they actually create the PR in which the number may have been taken. They to need to double check it.
Examples:
Modifications
Added clarification to step when creating the PR
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
If the box was checked, please highlight the changes
Documentation
docdoc-requireddoc-not-neededdoc-complete