This commit is contained in:
51
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
51
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: The openTCS Authors
|
||||
SPDX-License-Identifier: CC-BY-4.0
|
||||
-->
|
||||
|
||||
## Description
|
||||
|
||||
<!--
|
||||
Please explain the changes you made here, and why you made them.
|
||||
If this PR is related to an issue, reference it here.
|
||||
Note that, with a reference to an issue and/or an expressive commit message (see below), you can usually keep this quite short.
|
||||
-->
|
||||
|
||||
...
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] You have the right to contribute the code/documentation/assets to this project, and you agree to contribute it under the terms of the project's license(s).
|
||||
- [ ] All changes have been made on a separate branch (not master) in a fork.
|
||||
- [ ] The whole project compiles correctly and all tests pass, i.e. `gradlew clean build` succeeds with the changes made, and without unavoidable compiler/toolchain warnings.
|
||||
- [ ] New tests covering the change have been added, if it is possible / makes sense.
|
||||
- [ ] The documentation has been extended, if necessary.
|
||||
- [ ] The PR contains a proposal for a _well-formed_ commit message that mentions all authors who contributed to the PR.
|
||||
(The commits in the PR will be squashed into one commit on the base branch, and your proposed message is intended to be used for this commit. See below for a template you can use for the message. See [this blog post](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and [this one](https://chris.beams.io/posts/git-commit/#seven-rules) for more on well-formed commit messages.)
|
||||
|
||||
## Proposed squash commit message
|
||||
|
||||
<!--
|
||||
A proposed message for the eventual squashed commit.
|
||||
Please stick to the following pattern:
|
||||
|
||||
- A short one-line summary (max. 50 characters).
|
||||
- A blank line.
|
||||
- A detailed explanation of the changes introduced by this merge request.
|
||||
Each line should not exceed 72 characters.
|
||||
*********1*********2*********3*********4*********5*********6*********7** (<-- Ruler for line width assistance)
|
||||
-->
|
||||
```
|
||||
A short one-line summary (max. 50 characters)
|
||||
|
||||
A more detailed explanation of the changes introduced by this merge
|
||||
request.
|
||||
|
||||
* You can use lists here, too.
|
||||
* Each line should not exceed 72 characters.
|
||||
|
||||
Co-authored-by: NAME <EMAIL>
|
||||
```
|
||||
<!--
|
||||
*********1*********2*********3*********4*********5*********6*********7** (<-- Ruler for line width assistance)
|
||||
-->
|
||||
Reference in New Issue
Block a user