mirror of
https://github.com/louislam/uptime-kuma.git
synced 2025-06-06 13:12:33 +02:00
e0db3afc39
- Updated the pull request template with small improvements based on review feedback. - Ensured clarity and consistency across the document. modified: .github/PULL_REQUEST_TEMPLATE.md
110 lines
5.3 KiB
Markdown
110 lines
5.3 KiB
Markdown
**⚠️ 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**
|
||
|
||
**At this time, we may be slower to respond to new feature requests and review pull requests. Existing requests and PRs will remain in the backlog but may not be prioritized immediately.**
|
||
|
||
- **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](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.
|
||
|
||
## **❗ Important: Please Avoid Unnecessary Pinging of Maintainers**
|
||
|
||
**We kindly ask users to refrain from pinging maintainers unless absolutely necessary. Pings should be reserved for critical issues or urgent matters that require immediate attention.**
|
||
|
||
- **Why**: To help maintainers focus on high-priority tasks, we kindly request that unnecessary or repeated pings be minimized. This will help ensure quicker responses for matters that truly need attention.
|
||
- **What This Means**: Non-urgent pings may be ignored or addressed later. Please assess the urgency of your request before pinging a maintainer.
|
||
|
||
## 📋 Overview
|
||
|
||
Provide a clear summary of the purpose and scope of this pull request:
|
||
|
||
- **What problem does this pull request address?**
|
||
|
||
- Please provide a detailed explanation here.
|
||
|
||
- **Why is it necessary?**
|
||
|
||
- Please provide a detailed explanation here.
|
||
|
||
- **What features or functionality does this pull request introduce or enhance?**
|
||
|
||
- Please provide a detailed explanation here.
|
||
|
||
## 🔄 Changes
|
||
|
||
### 🛠️ Type of change
|
||
|
||
Please select all options that apply:
|
||
|
||
- [ ] 🐛 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.
|
||
|
||
## 🔗 Related Issues
|
||
|
||
Reference any related GitHub issues or tasks that this pull request addresses. Use issue links, for example:
|
||
|
||
- Relates to #issue-number
|
||
- Resolves #issue-number
|
||
- Fixes #issue-number
|
||
|
||
## 📄 Checklist
|
||
|
||
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
|
||
|
||
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.
|
||
|
||
<details><summary><b>For more details:</b> (click to expand)</summary>
|
||
</p>
|
||
|
||
If this pull request introduces visual changes, please provide the following details:
|
||
|
||
- **UI Modifications**: Highlight any changes made to the user interface.
|
||
- **Before & After**: Include screenshots or comparisons (if applicable).
|
||
|
||
| Event | Before | After |
|
||
| ------------------ | --------------------- | -------------------- |
|
||
| `UP` |  |  |
|
||
| `DOWN` |  |  |
|
||
| Certificate-expiry |  |  |
|
||
| Testing |  |  |
|
||
|
||
</p>
|
||
</details>
|
||
|
||
## ℹ️ Additional Context
|
||
|
||
Provide any additional information to help reviewers:
|
||
|
||
<details><summary><b>For more details:</b> (click to expand)</summary>
|
||
</p>
|
||
|
||
- 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.
|
||
|
||
</p>
|
||
</details>
|