Improve check list #5587
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,19 @@ | ||
| <!-- | ||
| Describe the changes you have made here: what, why, ... | ||
| Link issues by using the following pattern: #333. | ||
| If you fixed a koppor issue, link it with following pattern: [koppor#47](https://github.com/koppor/jabref/issues/47). | ||
| The title of the PR must not reference an issue, because GitHub does not support autolinking there. | ||
| --> | ||
|
|
||
| ## Checklist | ||
|
|
||
| I went through the following checklist and checked all items. All items with `[ ]` are still a TODO. All items checked with `[x]` are done. | ||
|
There was a problem hiding this comment. This should be a comment, right? There was a problem hiding this comment. No, I wanted to it to be rendered as text so that the user really takes care about the check list. There was a problem hiding this comment. It's however inconsistent with the other approaches when creating issues and about the description of a PR. |
||
|
|
||
| I added new TODOs at the end of the list (if applicable). | ||
|
|
||
| - [ ] Change in CHANGELOG.md described (if applicable) | ||
| - [ ] Tests created for changes (if applicable) | ||
| - [ ] Manually tested changed features in running JabRef (always required) | ||
| - [ ] Screenshots added in PR description (for bigger UI changes) | ||
| - [ ] Ensured that [the git commit message is a good one](https://github.com/joelparkerhenderson/git_commit_message) | ||
|
There was a problem hiding this comment. The git message doesn't really add anything. If I'm proposing a PR than the commits are already down. This can be added as a helpful comment at the end (for the next time). There was a problem hiding this comment. Yeah, we should move that to our contribution guideline |
||
| - [ ] Checked documentation status (issue created for outdated help page at [help.jabref.org](https://github.com/JabRef/help.jabref.org/issues)?) | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The body of the PR is always the most important one, thus I don't like the heading here as it puts too much emphasize on something relatively unimportant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted the thing to be more intuitively separated. Using
--it always felt a bit off. I wondered whether we should add a section## Description