mirror of
https://github.com/louislam/uptime-kuma.git
synced 2026-01-24 15:43:53 +08:00
chore: add a comment on first time contributors PRs instead of bloating the PR template (#6672)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
19
.github/PULL_REQUEST_TEMPLATE.md
vendored
19
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,36 +1,31 @@
|
||||
<sub>ℹ️ To keep reviews fast and effective, please make sure you’ve [read our pull request guidelines](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma)</sub>
|
||||
# Summary
|
||||
|
||||
## 📝 Summary of changes done and why they are done
|
||||
In this pull request, the following changes are made:
|
||||
|
||||
<!-- Provide a clear summary of the purpose and scope of this pull request-->
|
||||
|
||||
## 📋 Related issues
|
||||
- Foobar was changed to FooFoo, because ...
|
||||
|
||||
<!--Please link any GitHub issues or tasks that this pull request addresses-->
|
||||
|
||||
- Relates to #issue-number <!--this links related the issue-->
|
||||
- Resolves #issue-number <!--this auto-closes the issue-->
|
||||
|
||||
## 📄 Checklist
|
||||
|
||||
<details>
|
||||
<summary>Please follow this checklist to avoid unnecessary back and forth (click to expand)</summary>
|
||||
|
||||
- [ ] ⚠️ If there are Breaking change (a fix or feature that alters existing functionality in a way that could cause issues) I have called them out
|
||||
- [ ] 🧠 I have disclosed any use of LLMs/AI in this contribution and reviewed all generated content.
|
||||
I understand that I am responsible for and able to explain every line of code I submit.
|
||||
- [ ] 🔍 My code adheres to the style guidelines of this project.
|
||||
- [ ] ⚠️ My changes generate no new warnings.
|
||||
- [ ] 🛠️ I have reviewed and tested my code.
|
||||
- [ ] 🔍 Any UI changes adhere to visual style of this project.
|
||||
- [ ] 🛠️ I have self-reviewed and self-tested my code to ensure it works as expected.
|
||||
- [ ] 📝 I have commented my code, especially in hard-to-understand areas (e.g., using JSDoc for methods).
|
||||
- [ ] 🤖 I added or updated automated tests where appropriate.
|
||||
- [ ] 📄 Documentation updates are included (if applicable).
|
||||
- [ ] 🔒 I have considered potential security impacts and mitigated risks.
|
||||
- [ ] 🧰 Dependency updates are listed and explained.
|
||||
- [ ] ⚠️ CI passes and is green.
|
||||
|
||||
</details>
|
||||
|
||||
## 📷 Screenshots or Visual Changes
|
||||
## Screenshots for Visual Changes
|
||||
|
||||
<!--
|
||||
If this pull request introduces visual changes, please provide the following details.
|
||||
|
||||
38
.github/workflows/new_contributor_pr.yml
vendored
Normal file
38
.github/workflows/new_contributor_pr.yml
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
name: New contributor message
|
||||
|
||||
on:
|
||||
# Safety
|
||||
# This workflow uses pull_request_target so it can run with write permissions on first-time contributor PRs.
|
||||
# It is safe because it does not check out or execute any code from the pull request and
|
||||
# only uses the pinned, trusted actions/first-interaction action
|
||||
pull_request_target: # zizmor: ignore[dangerous-triggers]
|
||||
types: [opened]
|
||||
branches:
|
||||
- master
|
||||
|
||||
permissions:
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
build:
|
||||
if: github.repository == 'louislam/uptime-kuma'
|
||||
name: Hello new contributor
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 60
|
||||
steps:
|
||||
- uses: actions/first-interaction@1c4688942c71f71d4f5502a26ea67c331730fa4d # v3.1.0
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
pr-message: |
|
||||
Hello! Thank you for your contribution 👋
|
||||
|
||||
As this is your first contribution, please be sure to check out our
|
||||
[Pull Request guidelines](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma).
|
||||
|
||||
In particular:
|
||||
- Mark your PR as Draft while you’re still making changes
|
||||
- Mark it as Ready for review once it’s fully ready 🟢
|
||||
|
||||
If you have any design or process questions, feel free to ask them right here in this pull request - unclear documentation is a bug too.
|
||||
|
||||
Thanks for lending a paw to Uptime Kuma 🐻
|
||||
@@ -175,8 +175,8 @@ You can mention me if you ask a question on the subreddit.
|
||||
|
||||
### Create Pull Requests
|
||||
|
||||
We DO NOT accept all types of pull requests and do not want to waste your time. Please be sure that you have read and follow pull request rules:
|
||||
[CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma)
|
||||
Pull requests are awesome.
|
||||
To keep reviews fast and effective, please make sure you’ve [read our pull request guidelines](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma).
|
||||
|
||||
### Test Pull Requests
|
||||
|
||||
|
||||
Reference in New Issue
Block a user