luci: updates to Pull Request template and CONTRIBUTING.md

.github/pull_request_template.md

@@ -1,38 +1,61 @@
 <!-- 
 
-Thank you for your contribution to the luci repository.
+Thank you for your contribution to the LuCI repository.
 
-Please read this before creating your PR.
+/************************************************/
+/*   PLEASE READ THIS BEFORE CREATING YOUR PR   */
+/************************************************/
 
-Review https://github.com/openwrt/luci/blob/master/CONTRIBUTING.md
-especially if this is your first time to contribute to this repo.
+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 - put it on a separate branch
-- add merge commits to your PR: rebase locally and force-push
+- 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 to e.g. openwrt/openwrt
-- each commit subject line starts with '<package name>: title' 
-- each commit has a valid `Signed-off-by: ` (S.O.B.) with a reachable email
+- 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 below *optional* entries that do not apply
-- skip a `<package name>: title` first line subject if the commit is house-keeping or chore
+- 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.
 
 -->
 
-- [ ] 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: <[email protected]>` 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
-- [ ] Tested on: (architecture, openwrt version, browser) :white_check_mark:
-- [ ] \( Preferred ) Mention: @ the original code author for feedback
-- [ ] \( Preferred ) Screenshot or mp4 of changes:
-- [ ] \( Optional ) Closes: e.g. openwrt/luci#issue-number
-- [ ] \( Optional ) Depends on: e.g. openwrt/packages#pr-number in sister repo
-- [ ] Description: (describe the changes proposed in this PR)
+## Pull Request details
+
+### Description
+<!-- Describe the changes proposed in this PR. -->
+
+
+### Screenshot or video of changes _(If applicable)_
+<!-- Insert your screenshot or .mp4 here. -->
+
+
+### Maintainer _(Preferred)_
+<!-- You can find this by checking the history of the package Makefile. -->
+@<github-user>
+
+---
+
+## Tested on
+**OpenWrt version:** 
+**LuCI version:** 
+**Web browser:** 
+
+---
+
+## Checklist
+- [ ] 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: <[email protected]>` 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).

CONTRIBUTING.md

@@ -4,61 +4,61 @@
 
 Use [Weblate](https://hosted.weblate.org/engage/openwrt/?utm_source=widget) instead of direct editing of the `*.po` files.
 
-## Patches and Pull requests:
+## Patches and Pull Requests:
 
 If you want to contribute a change to LuCI, please either send a patch using git send-email
-or open a "pull request" against the openwrt/luci repository.
+or open a "Pull Request" against the openwrt/luci repository.
 
 Regardless of whether you send a patch or open a pull request, please try to follow these rules:
 
-* Have a useful subject prefixed with the component name
-    (E.g.: "luci-mod-admin-full: fix wifi channel selection on multiple STA networks")
-* Shortly explain the changes made and - if applicable - the reasoning behind them
-* Commit message of each commit should include a Signed-off-by line
+* Have a useful commit subject prefixed with the component name, with your commit subject having a reasonable number of characters. Your title after the component name must start with a lowercase letter.
+    (E.g.: "luci-mod-admin-full: wifi channel selection on STA networks")
+* In your commit message, shortly explain the changes made and - if applicable - the reasoning behind them, with your message having a reasonable number of characters per line. You cannot have an empty commit message.
+* Commit message of each commit **must** include a Signed-off-by line. Your first and last name should be used. Using a GitHub noreply email address will not be accepted.
     (See <https://openwrt.org/submitting-patches#sign_your_work>)
 
 In case you like to send patches by mail, please use the [OpenWrt Development List](https://lists.openwrt.org/mailman/listinfo/openwrt-devel), although patches to luci are preferred in [the luci repo on GitHub](https://github.com/openwrt/luci/pulls).
 
-If you send via the OpenWrt list, include a `[luci]` tag in your subject line.
+If you are sending via the OpenWrt list, include a `[luci]` tag in your subject line.
 For general information on patch submission, follow the [OpenWrt patch submission guideline](https://openwrt.org/submitting-patches).
 
-## Advice on pull requests:
+## Advice on Pull Requests:
 
-Pull requests are the easiest way to contribute changes to git repos at Github. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes.
+Pull Requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes.
 
 * You need a local "fork" of the Github repo.
-* Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. Workflow using `feature_x` as the example:
+* Create and use a "feature branch" that isn't named "master" or "main" for your changes. That separates the changes in the Pull Request from your other changes and makes it easy to edit/amend commits in the Pull Request. Workflow using `feature_x` as the example:
   - Update your local git fork to the tip (of the master, usually)
   - Create the feature branch with `git checkout -b feature_x`
   - Edit changes and commit them locally
-  - Push them to your Github fork by `git push -u origin feature_x`. That creates the `feature_x` branch at your Github fork and sets it as the remote of this branch
-  - When you now visit Github, you should see a proposal to create a pull request
+  - Push them to your GitHub fork by `git push -u origin feature_x`. That creates the `feature_x` branch at your GitHub fork and sets it as the remote of this branch
+  - When you now visit GitHub, you should see a proposal to create a Pull Request.
 
-* If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then use `git push` to automatically update the pull request.
+* If you later need to add new commits to the Pull Request, you can simply commit the changes to the local branch and then use `git push` to automatically update the Pull Request.
 
-* If you need to change something in the existing pull request (e.g. to add a missing signed-off-by line to the commit message), you can use `git push -f` to overwrite the original commits. That is easy and safe when using a feature branch. Example workflow:
+* If you need to change something in the existing Pull Request (e.g. to add a missing signed-off-by line to the commit message), you can use `git push -f` to overwrite the original commits. That is easy and safe when using a feature branch. Example workflow:
   - Checkout the feature branch by `git checkout feature_x`
   - Edit changes and commit them locally. If you are just updating the commit message in the last commit, you can use `git commit --amend` to do that
   - If you added several new commits or made other changes that require cleaning up, you can use `git rebase -i HEAD~X` (X = number of commits to edit) to possibly squash some commits
-  - Push the changed commits to Github with `git push -f` to overwrite the original commits in the "feature_x" branch with the new ones. The pull request gets automatically updated
+  - Push the changed commits to GitHub with `git push -f` to overwrite the original commits in the "feature_x" branch with the new ones. The Pull Request will be automatically updated.
 
 ## If you have commit access:
 
-* Do NOT use `git push --force`.
+* Do **NOT** use `git push --force`.
 * Use Pull Requests if you are unsure and to suggest changes to other developers.
 
 ## Gaining commit access:
 
 * Commit access will be granted to responsible contributors who have made
-  useful pull requests and / or feedback or patches to this repository or
+  useful Pull Requests and / or feedback or patches to this repository or
   OpenWrt in general. Please include your request for commit access in your
-  next pull request or ticket.
+  next Pull Request or ticket.
 
-## Release Branches:
+## Release branches:
 
 * Branches named `openwrt-xx.yy` (e.g. `openwrt-18.06`) are release branches.
 * These branches are built with the respective OpenWrt release and are created
   during the release stabilisation phase.
 * Please ONLY cherry-pick or commit security and bug-fixes to these branches.
-* Do NOT add new packages and do NOT do major upgrades of packages here.
-* If you are unsure if your change is suitable, please use a pull request.
+* Do **NOT** add new packages and do **NOT** do major upgrades of packages here.
+* If you are unsure if your change is suitable, please use a Pull Request.