luci: updates to Pull Request template and CONTRIBUTING.md#8527
luci: updates to Pull Request template and CONTRIBUTING.md#8527owlsy wants to merge 2 commits intoopenwrt:masterfrom
Conversation
|
For a proof of concept as well, the next comment is what the template would look like with the same information. |
358e252 to
fa12783
Compare
Pull Request detailsDescriptionAs a new person to contributing on GitHub, I noticed the Pull Request template and CONTRIBUTING.md missing some important information that I would not have known until I tried my first Pull Request, such as the character limits and email requirements. I've seen others also get tripped up by this too, as they also were not aware until afterwards. So, I have tried to include the common ones into:
The justification for combining the changes above are due to the intention of the edits — it is to ensure the user has an understanding of what is expected in order to contribute:
Regardless of the rationale above, if the layout is preferred as a seperate Pull Request, let me know and I will do so. Screenshot or video of changes (If applicable)
Maintainer (Preferred)
Tested onOpenWrt version: OpenWrt 25.12.2 (r32802-f505120278) Checklist
|
5a056d0 to
3cae0b5
Compare
|
Some of those field lengths aren't very helpful sometimes, and it's necessary to ignore them. The automated checks are a good rule of thumb, but they change, so we can skip mentions of length checks. It's probably enough to point a link to contributing.md in the template. |
|
Ah, good to know that those field lengths and length checks aren't enforced for a PR to be approved. It does seem to feel that way with how aggressive the "failure" is if it is over. I'll remove those mentions about length checks and tidy other mentions of it up. |
|
Should be good to go now, @systemcrash. |
55599b1 to
5aedb22
Compare
Failed checksIssues marked with an ❌ are failing checks. Commit 5aedb22
Commit 2ba9546
For more details, see the full job log. Something broken? Consider providing feedback. |
As a new person to contributing on GitHub, I noticed the Pull Request template missing some important information that I would not have known until I tried my first Pull Request, such as the character limits and email requirements. I've seen others also get tripped up by this too, as they also were not aware until afterwards. So, I have tried to include the common ones into the template. I have also prepared a layout that would ensure a more uniform experience when looking through Pull Requests, with expected headings and the ability to provide the instruction of what to put under each heading. Minor grammar and punctuation edits as well. If the layout is preferred as a seperate Pull Request, let me know and I will do so. Will also update the CONTRIBUTING.md file to achieve the same goal as well. Signed-off-by: Joshua Criss <owlsy@outlook.com.au>
As a new person to contributing on GitHub, I noticed the CONTRIBUTING.md missing some important information that I would not have known until I tried my first pull request, such as the character limits and email requirements. I've seen others also get tripped up by this too, as they also were not aware until afterwards. So, I have tried to include the common ones into the Contributing Guidelines, along with some minor capitalisation updates for consistency. Will also update the Pull Request template to achieve the same goal as well. Signed-off-by: Joshua Criss <owlsy@outlook.com.au>
5aedb22 to
3d2fbbe
Compare

As a new person to contributing on GitHub, I noticed the Pull Request template and CONTRIBUTING.md missing some important information that I would not have known until I tried my first Pull Request, such as the character limits and email requirements. I've seen others also get tripped up by this too, as they also were not aware until afterwards. So, I have tried to include the common ones into:
The justification for combining the changes above are due to the intention of the edits — it is to ensure the user has an understanding of what is expected in order to contribute:
Regardless of the rationale above, if the layout is preferred as a seperate Pull Request, let me know and I will do so.
For feedback,
@systemcrash for Pull Request template.
@jow-, possibly @hnyman @stokito @systemcrash for CONTRIBUTING.md file.
This PR is not from my main or master branch 💩, but a separate branch ✅
Each commit has a valid ✒️
Signed-off-by: <my@email.address>row (viagit commit --signoff)Each commit and PR title has a valid 📝
<package name>: titlefirst line subject for packagesIncremented 🆙 any
PKG_VERSIONin the Makefile (Not applicable)Tested on: (architecture, openwrt version, browser) ✅ (Not applicable)
( Preferred ) Mention: @ the original code author for feedback
( Preferred ) Screenshot or mp4 of changes: (Not applicable)
( Optional ) Closes: e.g. openwrt/luci#issue-number (Not applicable)
( Optional ) Depends on: e.g. openwrt/packages#pr-number in sister repo (Not applicable)
Description: (describe the changes proposed in this PR)