Simplify PR template #552
Merged
Simplify PR template #552
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
From my experience the PR template should call only for meaningful description. The code quality should be check automatically and presence of test should be validated by maintainers or by regression in code coverage. Also the simpler the PR template the easier is for new contributors to understand what is required from them and they do not feel overwhelmed by amount of required information.
|
@turbaszek I totally agree here! Some parts of the current template were taken from Zalando's template aligned to Zalando's compliance rules and processes. Others were an attempt to actually help the contributors by hinting them what to write and how and where to get that information. Related: #278 (originally zalando-incubator/kopf#278). Would you like to apply the same simplifying logic to the templates of bug-reports, questions, and feature requests? Or I can merge this PR as is, and do it later myself. |
nolar
approved these changes
Sep 21, 2020
|
@nolar I can do this in the upcoming week |
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.
From my experience the PR template should call only for
meaningful description. The code quality should be check
automatically and presence of test should be validated
by maintainers or by regression in code coverage.
Also the simpler the PR template the easier is for new contributors
to understand what is required from them and they do not feel
overwhelmed by amount of required information.
^ Add meaningful description above
Apart from providing meaningful description remember: