Add contribution templates + minor doc improvements #112
Conversation
Codecov Report
@@ Coverage Diff @@
## master #112 +/- ##
=======================================
Coverage 100% 100%
Complexity 133 133
=======================================
Files 6 6
Lines 556 556
=======================================
Hits 556 556Continue to review full report at Codecov.
|
There was a problem hiding this comment.
What are your thoughts about the following (may be adapted to PR template), extra diamond plated, branding version?
[ ] Bug in MO4 sniffer rule.
[ ] Bug in MO4 auto-fixer.
[ ] Bug in MO4 documentation.
[ ] Request to extend MO4 sniffer with specific rule.
[ ] Request to extend MO4 auto-fixer for specific rule.
[ ] Request to extend MO4 documentation.
[ ] Other (explain):
Ma27
force-pushed
the
doc-improvements
branch
from
d83e96d
to
296d4f8
Compare
|
fixed, train wifi seems to work today %) |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| * [ ] Bugfix | ||
| * [ ] New Feature | ||
| * [ ] Breaking change |
There was a problem hiding this comment.
I think "Breaking Change" should be on a separate Line/Section and the third point should be "something else" or "other".
There was a problem hiding this comment.
Regarding the addition of "else": full ack 👍
Regarding the "Breaking change" box: how would you propose to name this section?
I certainly get your point, I wasn't sure about this either, but in the end I thought that nobody forbids you to check multiple boxes (these are intentionally check boxes, not radio boxes). But as I said, I'm not sure about this and happy to discuss :)
There was a problem hiding this comment.
Sure, maybe just a headline "Is this a breaking chnage"? Otherwise we could also handle this with setting a respective label when reviewing.
Ma27
force-pushed
the
doc-improvements
branch
from
296d4f8
to
05e641d
Compare
|
@mmoll I slightly altered the PR and placed the breaking change part into its own section. Would you mind having another look? :) |
|
merged, danke @Ma27! |
This is just a proposal, I think it's helpful for first-time contributors to provide them a template which "tells" them what kind of information is needed.