docs: reword issue templates, pr workflow and review docs #5728

homelab-alpha · 2025-03-25T12:07:22Z

⚠️ 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

❗ Important Announcement

Click here for more details:

🚧 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 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.

🚫 Please Avoid Unnecessary Pinging of Maintainers

We kindly ask you to refrain from pinging maintainers unless absolutely necessary. Pings are reserved for critical/urgent pull requests that require immediate attention.

Why: Reserving pings for urgent matters ensures maintainers can prioritize critical tasks effectively.

📋 Overview

What problem does this pull request address?
- This PR enhances the management of Uptime Kuma.
Why is it necessary?
- This PR is necessary to streamline the process of managing Uptime Kuma. By updating and improving the documentation, the overall management and review process will be smoother, benefiting both contributors and maintainers.
What features or functionality does this pull request introduce or enhance?
- This pull request introduces enhanced documentation and organizational improvements to Uptime Kuma’s management. It focuses on improving the clarity of contribution guidelines, the review process, and clarifying related procedures.

🔄 Changes

🛠️ Type of change

🐛 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):
- Enhanced Management of Uptime Kuma.

🔗 Related Issues

Resolves Proposal for Improved Management of Uptime Kuma #5719

📄 Checklist *

ℹ️ Additional Context

Provide any relevant details to assist reviewers in understanding the changes.

Click here for more details:

📄 Document Status

✅ Ready for Review

ask_for_help.yml
bug_report.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
feature_request.yml
PULL_REQUEST_TEMPLATE.md
REVIEW_GUIDELINES.md
security_issue.yml
SECURITY.md

📝 Additional Changes

Fixed Linter Issues: Resolved linting problems across various files for better consistency and readability. (modified: .github/ISSUE_TEMPLATE/*.yml, .github/ISSUE_TEMPLATE/*.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md and SECURITY.md)
Ask for help Template Update: Enhanced structure, added guidelines on avoiding unnecessary pings, streamlined the submission process, and improved the security policy section.
Bug Report Template Update: Added section on pinging policy, updated labels, improved bug categorization, and clarified security policy section.
Feature Request Suspension: Temporarily suspended new feature requests, added notice of suspension and backlog status, and clarified pinging policy.
Security Issue Template Update: Added "P1: high" label, clarified GitHub Security Advisory usage, and improved instructions for security issues.
Pull Request Template Update: Added delay notice for feature requests and PR reviews due to prioritization of bug fixes.
File Renaming for Consistency: Renamed YAML files (ask-for-help.yaml → ask_for_help.yml, bug_report.yaml → bug_report.yml, feature_request.yaml → feature_request.yml) for consistency.
New Document: Added REVIEW_PROCESS.md for standardized pull request reviews.
Review Process File Rename: Renamed REVIEW_PROCESS.md to REVIEW_GUIDELINES.md for clarity.
Link Fixes: Corrected links in templates to point to the right locations (CONTRIBUTING.md, review guidelines).
Code of Conduct Update: Upgraded to Contributor Covenant v2.1 and revised language for inclusivity.
CONTRIBUTING.md Fixes: Fixed markdown linting issues, updated PR guidelines, and clarified feature scope discussions.
Security Issue Template Update: Improved clarity in the textarea label for GitHub Advisory URL.
Bug Report Template Adjustments: Improved clarity on "related-issues," security policy acknowledgment, and reporting format.
Ask for Help Template Revisions: Improved labels, instructions, and deployment environment section for clarity and consistency.
Minor Updates: Added emoji to "Description" label in bug report template for visual clarity.
Updated Pull Request Template: Minor adjustments to PULL_REQUEST_TEMPLATE.md for clarity and consistency based on feedback.
Updated Review Guidelines: Refinements to REVIEW_GUIDELINES.md for improved clarity, readability, and consistency based on feedback.
Updated URL Parameter: Changed URL query parameter from ? to ?q for proper search functionality.
Pull Request Template Refinement: Enhanced wording for clarity, improved the "Related Issues" and "Additional Context" sections, and made instructions more concise.
Updated Review Guidelines: Removed the "━ For Maintainers only" section that was unintentionally left in the file.
Pull Request Template: Improved structure, readability, and formatting with collapsible sections.
Minor adjustments for consistency in the issue templates:
- Ask for Help Template: Added pinging guidelines and improved formatting.
- Bug Report Template: Included pinging policy and enhanced readability.
- Feature Request Template: Updated with clear pinging guidelines.
- Security Issue Template: Applied minor formatting and consistency fixes.
Updated Sections in CONTRIBUTING.md: Aligned "Type of changes" and "Checklist" with Pull Request template for consistency.
Link Fix in CONTRIBUTING.md: Corrected the link to Pull Request guidelines, switching to a relative link for proper referencing.
Feedback: Changes made based on CommanderStorm's feedback.
Fixed: Update and align issue/PR templates with consistent style.

- Added a new section to discourage unnecessary pings to maintainers, ensuring better focus on high-priority tasks. - Introduced a checkbox to acknowledge understanding of the new pinging guidelines. - Streamlined issue submission process by emphasizing the importance of checking for duplicate issues before submitting. - Enhanced security policy section to ensure users agree to review it before reporting security-related issues. - Reorganized the template for clearer communication and improved user engagement. modified: .github/ISSUE_TEMPLATE/ask-for-help.yaml

- Added a markdown section to discourage unnecessary pings to maintainers, ensuring focused responses to urgent issues. - Introduced a checkbox to confirm understanding of the new pinging policy. - Updated the labels and assignees to improve issue categorization and accountability. - Streamlined the bug report process by making related issues search and explanation more prominent. - Enhanced the security policy section to ensure users acknowledge reading it before submitting security-related bugs. - Made minor adjustments to field descriptions for clarity and ease of use. modified: .github/ISSUE_TEMPLATE/bug_report.yaml

- Temporarily suspended the acceptance of new feature requests to focus on bug fixes, performance improvements, and critical updates. - Added a markdown section notifying users about the temporary suspension and the backlog status of existing requests. - Introduced a checkbox to confirm user understanding of the feature request suspension. - Enhanced the feature request template with a section about the policy on unnecessary pings to maintainers, including an acknowledgment checkbox. - Updated labels to include "P4: negligible" and "backlog" for better issue categorization. modified: .github/ISSUE_TEMPLATE/feature_request.yaml

…lines - Added "P1: high" label to security issues for better prioritization. - Updated markdown instructions to emphasize the importance of using GitHub Security Advisory for reporting vulnerabilities. - Clarified that this issue is solely for sharing the advisory URL and not for discussing the vulnerability details. - Retained the step-by-step guide for submitting and sharing the GitHub Security Advisory URL. modified: .github/ISSUE_TEMPLATE/security_issue.yml

homelab-alpha · 2025-03-25T12:31:57Z

Hi @CommanderStorm, if you have any time, would you be willing to look over my shoulder and provide feedback or input where necessary? I would greatly appreciate it.

.github/ISSUE_TEMPLATE/ask-for-help.yaml

.github/ISSUE_TEMPLATE/security_issue.yml

.github/ISSUE_TEMPLATE/bug_report.yaml

.github/ISSUE_TEMPLATE/feature_request.yaml

- Removed unnecessary checkboxes from issue templates. - Adjusted labels for better organization and easier searching in the GitHub UI. - Removed assignees to avoid unnecessary notifications. modified: .github/ISSUE_TEMPLATE/ask-for-help.yaml modified: .github/ISSUE_TEMPLATE/bug_report.yaml modified: .github/ISSUE_TEMPLATE/feature_request.yaml modified: .github/ISSUE_TEMPLATE/security_issue.yml

.github/ISSUE_TEMPLATE/feature_request.yaml

.github/ISSUE_TEMPLATE/bug_report.yaml

homelab-alpha · 2025-03-25T18:32:15Z

@CommanderStorm I will push the changes to GitHub tomorrow morning. I also have the pull request template ready.

I’d say it’s time to relax after a day of hard work and studying. Have a great evening!

- Added a section informing contributors about potential delays in feature requests and pull request reviews. - Updated the template to clarify that feature requests and PR reviews may be delayed due to focus on bug fixes and performance improvements. modified: .github/PULL_REQUEST_TEMPLATE.md

- Renamed the file from `ask-for-help.yaml` to `ask_for_help.yml` to adhere to consistent naming conventions. - This improves consistency and avoids potential issues with file naming conventions in different environments. renamed: .github/ISSUE_TEMPLATE/ask-for-help.yaml -> .github/ISSUE_TEMPLATE/ask_for_help.yml

…ust label - Renamed the file `bug_report.yaml` to `bug_report.yml` for consistency with standard YAML file extensions. - Changed the label from `P2-moderate` to `P2-medium` in the file for better alignment with naming conventions. renamed: .github/ISSUE_TEMPLATE/bug_report.yaml -> .github/ISSUE_TEMPLATE/bug_report.yml

…ure_request.yml - Renamed `feature_request.yaml` to `feature_request.yml` to follow project conventions. - Updated the description in the markdown content to reflect a temporary delay in feature requests and PR reviews. - Adjusted the labels and body content to better communicate the status of new feature requests. - Minor revisions in the markdown to enhance clarity and improve the user experience. renamed: .github/ISSUE_TEMPLATE/feature_request.yaml -> .github/ISSUE_TEMPLATE/feature_request.yml

- Added a new `REVIEW_PROCESS.md` file outlining the guidelines for reviewing pull requests. - The document aims to standardize the review process, ensuring consistency and improving code quality. - It includes sections on preparation, general review, testing, security, performance, compliance, and more. new file: .github/REVIEW_PROCESS.md

homelab-alpha · 2025-03-26T08:10:11Z

Quick question @CommanderStorm: I saw that you have adjusted several labels in the repository. Have you also checked the workflows to see if the existing labels are being used there?

If you haven’t done that, the workflows may not be able to place the labels simply because the labels have been changed. This could cause problems in the future.

Could you also take a look at the changes I made after last night? I really appreciate it!

CommanderStorm · 2025-03-26T09:17:09Z

No labels except the main categories will be looked at. Even those only by stalebot.

Will look at changes later in the week, am currently at a conference.

- Reworded the note about pull request acceptance to improve clarity. - Updated the phrasing to make the message more concise and user-friendly. - Changed the link text for better accessibility and readability. modified: .github/PULL_REQUEST_TEMPLATE.md

- Fixed Markdown formatting issues, including table alignment. - Resolved ESLint linter warnings related to code style. - Ignored `4 spaces indentation` coding style in the document. - Reworded and updated sections for clarity, especially around the Pull Request and issue assignment guidelines. modified: CONTRIBUTING.md

- Added a section to the "Recommended Pull Request Guideline" in CONTRIBUTING.md. - Included a recommendation to initiate a discussion by creating an empty pull request. - Ensured alignment on feature direction and scope to avoid conflicts and issues. modified: CONTRIBUTING.md

homelab-alpha · 2025-03-28T07:15:13Z

Good morning @CommanderStorm, I hope you had a great conference. If you have some time, would you be willing to take a look again and provide feedback or input where necessary? I would greatly appreciate it.

- Renamed the file `REVIEW_PROCESS.md` to `REVIEW_GUIDELINES.md` for clarity. - Made small adjustments to `PULL_REQUEST_TEMPLATE.md` and `feature_request.yml` to link to the newly renamed `REVIEW_GUIDELINES.md`. - Updated references to the review process throughout relevant files. modified: .github/ISSUE_TEMPLATE/feature_request.yml modified: .github/PULL_REQUEST_TEMPLATE.md renamed: .github/REVIEW_PROCESS.md -> .github/REVIEW_GUIDELINES.md

- Updated the link to the pull request rules in the PULL_REQUEST_TEMPLATE.md file. - Fixed the relative link to point to the correct location: `../CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma`. modified: .github/PULL_REQUEST_TEMPLATE.md

- Updated the links to the CONTRIBUTING.md file. - Fixed the relative link to point to the correct location: `../CONTRIBUTING.md#project-styles`. - Fixed the relative link to point to the correct location: `../CONTRIBUTING.md#coding-styles`. modified: .github/REVIEW_GUIDELINES.md

- Fixed the relative link to point to the correct location: `../REVIEW_GUIDELINES.md`. modified: .github/ISSUE_TEMPLATE/feature_request.yml

…Y.md - Corrected Markdown formatting issues in CONTRIBUTING.md and SECURITY.md. - Ensured files are properly linted for consistent styling and readability. modified: CONTRIBUTING.md modified: SECURITY.md

- Updated the CODE_OF_CONDUCT.md file to the latest version (v2.1). - Changed version reference from v2.0 to v2.1. - Revised the language and added new inclusivity terms (e.g., "caste" and "color"). - Updated enforcement and reporting sections for clarity and precision. modified: CODE_OF_CONDUCT.md

…iners - Added a new section with clear guidelines on when and when not to ping maintainers. - Improved readability with a structured format for better comprehension. - Applied minor Markdown adjustments for consistency and clarity. modified: .github/ISSUE_TEMPLATE/ask_for_help.yml

- Added a new section with clear guidelines on when and when not to ping maintainers. - Improved readability with a structured format for better comprehension. - Applied minor Markdown adjustments for consistency and clarity. modified: .github/ISSUE_TEMPLATE/bug_report.yml

…ntainers - Added a new section with clear guidelines on when and when not to ping maintainers. - Improved readability with a structured format for better comprehension. - Applied minor Markdown adjustments for consistency and clarity. modified: .github/ISSUE_TEMPLATE/feature_request.yml

- Improved formatting for better readability. - Adjusted heading styles and emphasis for clarity. - Ensured consistency in the security vulnerability reporting instructions. modified: .github/ISSUE_TEMPLATE/security_issue.yml

homelab-alpha · 2025-04-02T07:13:15Z

@CommanderStorm Okay, I figured out how you can test the issues in my fork of the Uptime Kuma repository. I had to change the default branch to the discussion-for-improved-management-of-uptime-kuma and now everything works fine.

If you have some time, would you be willing to take another look and provide feedback or input where necessary? I would greatly appreciate it.

…mplate - Updated the "Type of changes" and "Checklist" sections in CONTRIBUTING.md. - Ensured the formatting and wording match the guidelines provided in the pull request template for consistency. modified: CONTRIBUTING.md

- Updated the link to the Pull Request guidelines to use a relative link instead of an absolute one. - Ensured the link now correctly references the section within the same file. modified: CONTRIBUTING.md

.github/ISSUE_TEMPLATE/bug_report.yml

.github/ISSUE_TEMPLATE/feature_request.yml

.github/PULL_REQUEST_TEMPLATE.md

CommanderStorm · 2025-04-02T22:51:42Z

@homelab-alpha FYI: You marked it as a draft. Is this intentional?
I would be happy to merge as is (assuming we merge the rewordings ^^).

- CommanderStorm: Too long forms don't get read, lets rephrase it as follows Co-authored-by: Frank Elsinga <frank@elsinga.de>

Co-authored-by: Frank Elsinga <frank@elsinga.de>

- CommanderStorm: Too long forms don't get read, lets rephrase it as follows Co-authored-by: Frank Elsinga <frank@elsinga.de>

- Remove asterisk from `Overview` Co-authored-by: Frank Elsinga <frank@elsinga.de>

- Remove asterisk from `Type of change` Co-authored-by: Frank Elsinga <frank@elsinga.de>

- Minor change Co-authored-by: Frank Elsinga <frank@elsinga.de>

- Minor change removed `</details>` Co-authored-by: Frank Elsinga <frank@elsinga.de>

- Minor change: remove `Why is it necessary?` - CommanderStorm: Boils down to the same information. Co-authored-by: Frank Elsinga <frank@elsinga.de>

- Minor change removed `</details>` Co-authored-by: Frank Elsinga <frank@elsinga.de>

- CommanderStorm: Let's simplify it to just Requested Feedback. Co-authored-by: Frank Elsinga <frank@elsinga.de>

- CommanderStorm: If the signal-to-noise ratio is too low, nobody is reading this => let's remove it. Co-authored-by: Frank Elsinga <frank@elsinga.de>

- Fixed minor markdown issues in the templates to ensure consistency. - Updated formatting for better readability and uniformity. - Ensured that all templates (issue, PR) follow the same style. modified: .github/ISSUE_TEMPLATE/ask_for_help.yml modified: .github/ISSUE_TEMPLATE/bug_report.yml modified: .github/ISSUE_TEMPLATE/feature_request.yml modified: .github/PULL_REQUEST_TEMPLATE.md

homelab-alpha · 2025-04-03T07:37:19Z

Good morning @CommanderStorm,

I’ve processed all your feedback and made the necessary adjustments. The PR is now ready for a general review.

One small note: there’s a slight chance the link in feature_request.yml to REVIEW_GUIDELINES.md may not work. If that happens, I’ll fix the link in feature_request.yml once the PR is merged.

Thank you for your valuable input and patience throughout this process. I truly appreciate the great collaboration, and I look forward to working together on the next PR.

homelab-alpha added 4 commits March 25, 2025 12:50