docs: add notation in pull-request template #832
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
Signed-off-by: Kotaro Yoshimoto <[email protected]>
HansRobo
changed the title
HansRobo
changed the title
Signed-off-by: Kotaro Yoshimoto <[email protected]>
|
@mitsudome-r @h-ohta |
h-ohta
approved these changes
Nov 29, 2024
|
I checked operation in #840 |
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.
Since not a few people submit PRs by providing only a link with their own usage only, I decided to add a notation to the PR template like below
TODO: Update this comment and add some reference links.
your usage of the word: link of github or something
The documentation for the word: link for word documentation
Note
To get approval, you need to show external documentation proving that the word is not your own creation, but is common in the public and industry.
Please check CONTRIBUTING.md for detail.