diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 93cd7700cdb0..a021dc72bc99 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,9 +2,9 @@ Thank you for your contribution to the LuCI repository. -/************************************************/ -/* PLEASE READ THIS BEFORE CREATING YOUR PR */ -/************************************************/ +/*************************************************************************/ +/* 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.) @@ -18,7 +18,7 @@ MUST: - Set to draft if this PR depends on other PRs as well (e.g. openwrt/openwrt). - Have each commit subject line starting with ': 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). +- 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` @@ -29,30 +29,35 @@ MAY: --> -## Pull Request details +## Pull request details ### Description -### Screenshot or video of changes _(If applicable)_ - +### Screenshot or video of changes _(if applicable)_ + -### Maintainer _(Preferred)_ +### Maintainer _(preferred)_ @ --- ## Tested on -**OpenWrt version:** -**LuCI version:** -**Web browser:** + +**OpenWrt version:** +**LuCI version:** +**Web browser(s):** --- ## 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: ` row (via `git commit --signoff`). - [ ] Each commit and PR title has a valid :memo: `: title` first line subject for packages. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index affc4f6b5f33..58d38bd821ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,9 @@ 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. +If you want to contribute a change to LuCI, please either send a patch using git send-email or open a pull request (PR) against the openwrt/luci repository. Regardless of whether you send a patch or open a pull request, please try to follow these rules: @@ -19,46 +18,41 @@ Regardless of whether you send a patch or open a pull request, please try to fol 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 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). +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. -* 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: +* 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. + - 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 will be 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: +## If you have commit access -* Do **NOT** use `git push --force`. -* Use Pull Requests if you are unsure and to suggest changes to other developers. +* Do **not** use `git push --force`. +* Use pull requests if you are unsure and to suggest changes to other developers. -## Gaining commit access: +## 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 - OpenWrt in general. Please include your request for commit access in your - next Pull Request or ticket. +* Commit access will be granted to responsible contributors who have made 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. -## 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. +* Branches named `openwrt-xx.yy` (e.g. `openwrt-25.12`) 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.