mirror of
https://github.com/Helium314/HeliBoard.git
synced 2025-05-15 06:22:45 +00:00
update readme / templates / guidelines
This commit is contained in:
parent
092cac529f
commit
71d17f6792
4 changed files with 13 additions and 12 deletions
3
.github/ISSUE_TEMPLATE/bug_report.md
vendored
3
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -12,13 +12,14 @@ tl;dr:
|
|||
|
||||
<!--
|
||||
issue template below, please remove above text before submitting (and the template too if you think it's a good idea)
|
||||
Please choose a meaningful title for your issue
|
||||
Please choose a meaningful title for your issue, and consider that if you want help you should provide enough information that people can actually help
|
||||
-->
|
||||
|
||||
**Describe the bug**
|
||||
|
||||
**To Reproduce**
|
||||
If possible, provide all the necessary steps to reproduce your problem, including the involved apps or settings if relevant.
|
||||
In case you cannot reproduce the bug, say so and provide information about when the bug may occur for you. Settings and the app you're writing in are usually important, please don't omit them.
|
||||
|
||||
**Expected behavior**
|
||||
If it's not obvious (e.g. not crash), describe how you think the app should behave.
|
||||
|
|
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -8,9 +8,11 @@ tl;dr (you should still read the full list though):
|
|||
* make it a draft if you still want to work on it
|
||||
* no translations or dictionaries
|
||||
|
||||
A good description and small scope ("single thing") massively help with reviewing. Don't be surprised when your PR gets closes if you clearly / repeatedly violate these parts of the guidelines.
|
||||
|
||||
Further
|
||||
* When the PR contains "fixes" <issue number>, the related issue will be linked and automatically closed if the PR is merged (also works for other words like "fix", "resolve", "resolves", "closes", ...)
|
||||
* If you add a keyboard layout, make sure you also read https://github.com/Helium314/HeliBoard/blob/main/layouts.md#adding-new-layouts--languages
|
||||
* Please avoid force-pushing when doing changes. This way it's not possible to see which parts have changed since the previous state.
|
||||
* Please avoid force-pushing when doing changes unless you have a good reason. This way it's not possible to see which parts have changed since the previous state.
|
||||
|
||||
<!-- (please remove the text above before submitting the PR) -->
|
Loading…
Add table
Add a link
Reference in a new issue