mirror of
https://github.com/louislam/uptime-kuma.git
synced 2025-05-31 02:42:34 +02:00
Updated: Improve pull request template formatting
- Enhanced the pull request template for better clarity and organization. - Updated sections for easier comprehension of the guidelines and checklist. - Converted inline links to proper markdown format for better readability. modified: .github/PULL_REQUEST_TEMPLATE.md
This commit is contained in:
GJS
parent
627dcfb7a2
commit
b09813ea20
1 changed files with 78 additions and 28 deletions
106
.github/PULL_REQUEST_TEMPLATE.md
vendored
106
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -1,10 +1,4 @@
|
|||
**⚠️ Please Note: We do not accept all types of pull requests, and we want to ensure we don’t waste your time. Before submitting, make sure you have read our pull request guidelines: [Pull Request Rules]**
|
||||
|
||||
[Pull Request Rules]: ../CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma
|
||||
|
||||
Check the box below if you understand [x]:
|
||||
|
||||
- [ ] I have read and understand the pull request rules.
|
||||
**⚠️ Please Note: We do not accept all types of pull requests, and we want to ensure we don’t waste your time. Before submitting, make sure you have read our pull request guidelines: [Pull Request Rules](../CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma)**
|
||||
|
||||
## **❗ Important: Temporary Delay in Feature Requests and Pull Request Reviews**
|
||||
|
||||
|
|
@ -12,36 +6,92 @@ Check the box below if you understand [x]:
|
|||
|
||||
- **Reason**: Our current focus is on addressing bugs, improving system performance, and implementing essential updates. This will help stabilize the project and ensure smoother management.
|
||||
- **Impact**: While no new feature requests or pull requests are being outright rejected, there may be significant delays in reviews. We encourage the community to help by reviewing PRs or assisting other users in the meantime.
|
||||
- **What You Can Do**: If you're interested in contributing, reviewing open PRs by following our [Review Guidelines] or offering support to other users is greatly appreciated. All feature requests and PRs will be revisited once the suspension period is lifted.
|
||||
- **What You Can Do**: If you're interested in contributing, reviewing open PRs by following our [Review Guidelines](REVIEW_GUIDELINES.md) or offering support to other users is greatly appreciated. All feature requests and PRs will be revisited once the suspension period is lifted.
|
||||
|
||||
We appreciate your patience and understanding as we continue to improve Uptime Kuma.
|
||||
|
||||
[Review Guidelines]: REVIEW_GUIDELINES.md
|
||||
## 📋 Overview
|
||||
|
||||
## Description
|
||||
**Required**: Please fill out this section before submitting.
|
||||
|
||||
Fixes #(issue)
|
||||
Provide a clear summary of the purpose and scope of this pull request:
|
||||
|
||||
## Type of change
|
||||
- What problem does this pull request address?
|
||||
- Why is it necessary?
|
||||
- What features or functionality does this pull request introduce or enhance?
|
||||
|
||||
Please delete any options that are not relevant.
|
||||
## 🔄 Changes
|
||||
|
||||
- Bug fix (non-breaking change which fixes an issue)
|
||||
- User interface (UI)
|
||||
- New feature (non-breaking change which adds functionality)
|
||||
- Breaking change (a fix or feature that would cause existing functionality to not work as expected)
|
||||
- Other
|
||||
- This change requires a documentation update
|
||||
### 🛠️ Type of change
|
||||
|
||||
## Checklist
|
||||
**Required**: Please fill out this section before submitting.
|
||||
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I ran ESLint and other linters for modified files
|
||||
- [ ] I have performed a self-review of my own code and tested it
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas (including JSDoc for methods)
|
||||
- [ ] My changes generates no new warnings
|
||||
- [ ] My code needed automated testing. I have added them (this is optional task)
|
||||
Please select all options that apply:
|
||||
|
||||
## Screenshots (if any)
|
||||
- [ ] 🐛 Bugfix (a non-breaking change that resolves an issue)
|
||||
- [ ] ✨ New feature (a non-breaking change that adds new functionality)
|
||||
- [ ] ⚠️ Breaking change (a fix or feature that alters existing functionality in a way that could cause issues)
|
||||
- [ ] 🎨 User Interface (UI) updates
|
||||
- [ ] 📄 New Documentation (addition of new documentation)
|
||||
- [ ] 📄 Documentation Update (modification of existing documentation)
|
||||
- [ ] 📄 Documentation Update Required (the change requires updates to related documentation)
|
||||
- [ ] 🔧 Other (please specify):
|
||||
- Provide additional details here.
|
||||
|
||||
Please do not use any external image service. Instead, just paste in or drag and drop the image here, and it will be uploaded automatically.
|
||||
## 🔗 Related Issues
|
||||
|
||||
**Optional**: Remove this section if not applicable.
|
||||
|
||||
Reference any related GitHub issues or tasks that this pull request addresses. Use proper issue links or numbers, for example:
|
||||
|
||||
- Relates to #issue-number
|
||||
- Resolves #issue-number
|
||||
- Fixes #issue-number
|
||||
|
||||
## 📄 Checklist
|
||||
|
||||
**Required**: Please fill out this section before submitting.
|
||||
|
||||
Please select all options that apply:
|
||||
|
||||
- [ ] 🔍 My code adheres to the style guidelines of this project.
|
||||
- [ ] ✅ I ran ESLint and other code linters for modified files.
|
||||
- [ ] 🛠️ I have reviewed and tested my code.
|
||||
- [ ] 📝 I have commented my code, especially in hard-to-understand areas (e.g., using JSDoc for methods).
|
||||
- [ ] ⚠️ My changes generate no new warnings.
|
||||
- [ ] 🤖 My code needed automated testing. I have added them (this is an optional task).
|
||||
- [ ] 📄 Documentation updates are included (if applicable).
|
||||
- [ ] 🔒 I have considered potential security impacts and mitigated risks.
|
||||
- [ ] 🧰 Dependency updates are listed and explained.
|
||||
- [ ] 📚 I have read and understood the [Pull Request guidelines](../CONTRIBUTING.md#recommended-pull-request-guideline).
|
||||
|
||||
## 📷 Screenshots or Visual Changes
|
||||
|
||||
**Optional**: Remove this section if not applicable.
|
||||
|
||||
Please upload the image directly here by pasting it or dragging and dropping. Avoid using external image services as the image will be uploaded automatically.
|
||||
|
||||
If this pull request introduces visual changes, provide the following:
|
||||
|
||||
- **UI Modifications**: Highlight any changes made to the user interface.
|
||||
- **Before & After**: Include screenshots or comparisons (if applicable).
|
||||
|
||||
```md
|
||||
| Event | Before | After |
|
||||
| ------------------ | --------------------- | -------------------- |
|
||||
| `UP` |  |  |
|
||||
| `DOWN` |  |  |
|
||||
| Certificate-expiry |  |  |
|
||||
| Testing |  |  |
|
||||
```
|
||||
|
||||
## ℹ️ Additional Context
|
||||
|
||||
**Optional**: Remove this section if not applicable.
|
||||
|
||||
Provide any additional information to help reviewers:
|
||||
|
||||
- Design decisions or trade-offs made during development.
|
||||
- Alternative solutions considered but not implemented.
|
||||
- Relevant links, such as specifications, discussions, or resources.
|
||||
- Dependencies or related pull requests that must be addressed before merging.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue