Pull Request template: link to contribution guide #7314
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: Shlomi Noach <[email protected]>
deepthi
reviewed
Jan 20, 2021
.github/pull_request_template.md
Outdated
| @@ -1,3 +1,8 @@ | |||
| <!-- | |||
| How to contribute: https://vitess.io/docs/contributing/ | |||
| We’re looking forward to any contribution! Before you start larger contributions, make sure to reach out first and discuss your plans with us. | |||
There was a problem hiding this comment.
us should link somewhere useful. (I know the doc on the website has the same language and the same problem).
How about linking it to the #developers slack channel?
There was a problem hiding this comment.
Agreed that "us" is vague. This line was copied from https://vitess.io/docs/contributing/ by way of TL;DR. I'm not sure we want to ask people to discuss all contributions on #developers . We should rather encourage them to open an issue. What do you think?
There was a problem hiding this comment.
Yes! Let us ask them to create an issue to document the feature, and if they have a proposal it can be marked as an RFC.
Signed-off-by: Shlomi Noach <[email protected]>
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.
Description
As discussed in an internal meeting, we see many contributions that are not linked with an existing issue or a prior discussion.
This PR updated th epull request template to first and foremost ask the submitter to read the Contributing guide on the Vitess docs.
Checklist