luckyimnotanigger/HeliBoard
1
0
Fork 0
mirror of https://github.com/Helium314/HeliBoard.git synced 2025-05-27 04:07:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

clarify that some parts of the contribution guidelines are (strongly) recommended, but not necessary

Browse source
This commit is contained in:
Helium314 2025-02-02 21:50:33 +01:00
parent 274c6b0212
commit d57301918e
3 changed files with 59 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

13
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,18 +1,19 @@
See the contributing readme for more detailed guideline, please understand and accept them: https://github.com/Helium314/HeliBoard/blob/main/CONTRIBUTING.md
tl;dr (you should still read the full list though):
* make sure it's wanted
See the contributing readme for more detailed guidelines: https://github.com/Helium314/HeliBoard/blob/main/CONTRIBUTING.md#guidelines
tl;dr:
necessary;
* a single thing only
* describe it properly
recommended:
* make changes optional
* re-use existing mechanisms / code
* low performance impact
* 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 unless you have a good reason. This way it's not possible to see which parts have changed since the previous state.
* If you add a keyboard layout, best read https://github.com/Helium314/HeliBoard/blob/main/layouts.md#adding-new-layouts--languages
* Please avoid force-pushing when doing requested changes. 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) -->