monkeytypegame/monkeytype
1
1
Fork 0
mirror of https://github.com/monkeytypegame/monkeytype.git synced 2024-09-20 07:16:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: made the the PR template more informative (aikooo7) (#4689)

Browse source 
* docs: added some checkboxes, a heading and a comment explaining it.

Why is this good?

- People usually don't do things unless they are asked to and also can
  happen that they just know it. Mostly the conventional commit
  messages.

* docs: added some comments about the ci checks and a bonus comment to
remove the "close #" if you are not using it.

* updated checks

* we are already talking about conventional commits in the checks section

* refactor: ensure language and theme comments are within checks also
move comment for visual changes to descriptions for screenshots

* refactor: moved "adding screenshots" to the checks section.

---------

Co-authored-by: Miodec <jack@monkeytype.com>
This commit is contained in:
aikoo7 2023-11-10 13:59:37 +00:00 committed by GitHub
parent e5e03b603f
commit 46a39b8322
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
.github/pull_request_template.md vendored
View file

@ -1,19 +1,24 @@
<!-- Adding a language or a theme?
For languages, make sure to edit the `_list.json`, `_groups.json` files, and add the `language.json` file as well.
For themes, make sure to add the `theme.css` file. It will not work if you don't follow these steps!
If your change is visual (mainly themes) it would be extra awesome if you could include a screenshot.
-->
### Description
<!-- Please describe the change(s) made in your PR -->
### Checks
- [ ] Adding a language or a theme?
- [ ] If is a language, did you edit `_list.json`, `_groups.json` and add `languages.json`?
- [ ] If is a theme, did you add the theme.css?
- Also please add a screenshot of the theme, it would be extra awesome if you do so!
- [ ] Check if any open issues are related to this PR; if so, be sure to tag them below.
- [ ] Make sure the PR title follows the Conventional Commits standard. (https://www.conventionalcommits.org for more info)
- [ ] Make sure to include your GitHub username inside round brackets at the end of the PR title
<!-- I know I know they seem boring but please do them, they help us and you will find out it also helps you.-->
Closes #
<!-- the issue(s) your PR resolves if any (delete if that is not the case) -->
<!-- please also reference any issues and or PRs related to your pull request -->
<!-- Also remove it if you are not following any issues. -->
<!-- pro tip: you can mention an issue, PR, or discussion on GitHub by referencing its hash number e.g: [#1234](https://github.com/monkeytypegame/monkeytype/pull/1234) -->