diff options
| author | Matthias Beyer <matthias.beyer@ifm.com> | 2022-01-10 08:01:16 +0100 |
|---|---|---|
| committer | Matthias Beyer <matthias.beyer@ifm.com> | 2022-02-18 12:31:08 +0100 |
| commit | b7588bed7aee1045653c93591023488702e946e6 (patch) | |
| tree | 88a199753b3f3c46afc6018af8db535195e7d437 /.github/pull_request_template.md | |
| parent | 4a10c42a6a0c6cc106cbecaabe1322a3926b1968 (diff) | |
Change description for PR sections to be comments
this way they do not show up in every issue, resulting in less textual
noise.
Signed-off-by: Matthias Beyer <matthias.beyer@ifm.com>
Diffstat (limited to '.github/pull_request_template.md')
| -rw-r--r-- | .github/pull_request_template.md | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5a9a3fb5..8b213dc5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,11 +1,17 @@ ## Proposed changes -Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue. +<!-- +Describe the big picture of your changes here to communicate to the +maintainers why we should accept this pull request. If it fixes a bug or +resolves a feature request, be sure to link to that issue. +--> ## Types of changes +<!-- What types of changes does your code introduce to `thin-edge.io`? _Put an `x` in the boxes that apply_ +--> - [ ] Bugfix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) @@ -18,7 +24,12 @@ _Put an `x` in the boxes that apply_ ## Checklist -_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ +<!-- +_Put an `x` in the boxes that apply. You can also fill these out after +creating the PR. If you're unsure about any of them, don't hesitate to ask. +We're here to help! This is simply a reminder of what we are going to look for +before merging your code._ +--> - [ ] I have read the [CONTRIBUTING](https://github.com/thin-edge/thin-edge.io/blob/main/CONTRIBUTING.md) doc - [ ] I have signed the [CLA](https://github.com/thin-edge/thin-edge.io/blob/main/CONTRIBUTOR-LICENSE-AGREEMENT.md) (in all commits with git commit -s) @@ -29,4 +40,9 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating ## Further comments -If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... +<!-- +If this is a relatively large or complex change, kick off the discussion by +explaining why you chose the solution you did and what alternatives you +considered, etc... +--> + |