mirror of
https://github.com/Helium314/HeliBoard.git
synced 2025-05-14 14:02:44 +00:00
update PR template
This commit is contained in:
parent
f48cd06641
commit
aba68b114b
1 changed files with 10 additions and 3 deletions
13
.github/PULL_REQUEST_TEMPLATE.md
vendored
13
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -1,6 +1,13 @@
|
||||||
<!--
|
<!--
|
||||||
* Describe briefly what your pull request proposes to fix or improve.
|
* Describe briefly what your pull request proposes to fix or improve.
|
||||||
* If it's not completely obvious, describe what the PR does to achieve the desired result. Do no waste the maintainers' or anyone elses time by making them find out instead.
|
* If it's not completely obvious, describe what the PR does to achieve the desired result. This can help avoiding time consuming discussions.
|
||||||
* If you use someone else's code (e.g. from another AOSP fork), please mention the source.
|
* If you use someone else's code (e.g. from another AOSP fork), please mention the source. Or even better link to the commit, as this may provide additional context.
|
||||||
* Which device / Android version did you test the PR on?
|
* Which device / Android version did you test the PR on? The keyboard may behave differently on different devices, e.g. due to Android version or screen size.
|
||||||
|
|
||||||
|
If you're not familiar with pull requests, some essentials:
|
||||||
|
* A pull request should contain only one feature. This way reviewing and discussion is much simpler than for a all-my-favorite-features PR.
|
||||||
|
* Before investing a lot of time, make sure the feature you want to contribute is actually wanted, e.g. by checking issues or opening an issue (and possibly offering to work on it).
|
||||||
|
* If you intend to do large changes, it might be good to start with a draft PR and discuss your approch. It may turn out your initial approach will need changes, so by discussing early you can avoid wasting time on re-writing code.
|
||||||
|
* You should be able and willing to explain the changes you did, as well as your reasoning. This is especially relevant for changes that at first glance seem unrelated to the goals of your PR.
|
||||||
|
* If you want to spend the time, you can read more detailed guides on "good PRs", e.g. https://betterprogramming.pub/how-to-create-a-good-pull-request-and-how-to-review-one-c30a13f61fd2
|
||||||
-->
|
-->
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue