mirror of
https://github.com/openwrt/luci.git
synced 2026-05-31 10:31:55 +08:00
Joshua Criss
5552cf2701
For PR template, minor fix to 'please read' section, as symbol spacing was different on GitHub website than on GitHub Desktop. Added HTML comment with example on how to complete the checklist using [x]. Added examples to the 'tested on' section. Added abbreviation explanation for PR to better understand terminology, similar to using S.O.B. For CONTRIBUTING.md, bumped up release branch example, and minor capitalisation fixes for PR. Signed-off-by: Joshua Criss <owlsy@outlook.com.au>
67 lines
2.8 KiB
Markdown
67 lines
2.8 KiB
Markdown
<!--
|
|
|
|
Thank you for your contribution to the LuCI repository.
|
|
|
|
/*************************************************************************/
|
|
/* PLEASE READ THIS BEFORE CREATING YOUR PULL REQUEST (PR) */
|
|
/*************************************************************************/
|
|
|
|
Review the Contributing Guidelines: https://github.com/openwrt/luci/blob/master/CONTRIBUTING.md
|
|
(Especially if this is your first time to contribute to this repo.)
|
|
|
|
MUST NOT:
|
|
- Add a PR from your *main* branch - instead, put it on a separate branch.
|
|
- Add merge commits to your PR - instead, rebase locally and force-push.
|
|
|
|
MUST:
|
|
- Increment any PKG_VERSION in the affected Makefile.
|
|
- Set to draft if this PR depends on other PRs as well (e.g. openwrt/openwrt).
|
|
- Have each commit subject line starting with '<package name>: title', and the title starting in lowercase, with a reasonable number of characters total.
|
|
- Have a commit comment as it cannot be empty, with a reasonable number of characters per line.
|
|
- Have each commit with a valid `Signed-off-by:` (S.O.B.) with a reachable email (GitHub noreply emails are not accepted).
|
|
* Forgot? `git commit --amend ; git push -f`
|
|
* Tip: use `git commit --signoff`
|
|
|
|
MAY:
|
|
- Your S.O.B. *may* be a nickname.
|
|
- Delete the *optional* entries in the checklist that do not apply.
|
|
- Skip a `<package name>: title` first line subject if the commit is for house-keeping or a chore.
|
|
|
|
-->
|
|
|
|
## Pull request details
|
|
|
|
### Description
|
|
<!-- Describe the changes proposed in this PR. -->
|
|
|
|
|
|
### Screenshot or video of changes _(if applicable)_
|
|
<!-- Insert your screenshot or video here. -->
|
|
|
|
|
|
### Maintainer _(preferred)_
|
|
<!-- You can find this by checking the history of the package Makefile. -->
|
|
@<github-user>
|
|
|
|
---
|
|
|
|
## Tested on
|
|
<!-- You can find this by:
|
|
- looking at the footer on LuCI,
|
|
- or using the following command: ubus call system board -->
|
|
**OpenWrt version:** <!-- e.g. OpenWrt 25.12.2 (r32802-f505120278) -->
|
|
**LuCI version:** <!-- e.g. LuCI openwrt-25.12 branch (26.100.49936~3cefdb7) -->
|
|
**Web browser(s):** <!-- e.g. Chrome 147.0.7727.55, Safari 26.5 (21624.2.2) -->
|
|
|
|
---
|
|
|
|
## Checklist
|
|
<!-- Place an x inside each [ ] and remove the empty space to check each item off the list.
|
|
They should look like this: [x], otherwise leave them as is. -->
|
|
- [ ] This PR is not from my *main* or *master* branch :poop:, but a *separate* branch. :white_check_mark:
|
|
- [ ] Each commit has a valid :black_nib: `Signed-off-by: <my@email.address>` row (via `git commit --signoff`).
|
|
- [ ] Each commit and PR title has a valid :memo: `<package name>: title` first line subject for packages.
|
|
- [ ] Incremented :up: any `PKG_VERSION` in the Makefile.
|
|
- [ ] _(Optional)_ Includes what Issue it closes (e.g. openwrt/luci#issue-number).
|
|
- [ ] _(Optional)_ Includes what it depends on (e.g. openwrt/packages#pr-number in sister repo).
|