Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance security issue template #5593

Conversation

homelab-alpha
Copy link
Contributor

⚠️⚠️⚠️ Since we do not accept all types of pull requests and do not want to waste your time. Please be sure that you have read pull request rules:
https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma

Tick the checkbox if you understand [x]:

  • I have read and understand the pull request rules.

Description

This pull request improves the security issue template to enhance the clarity and consistency of reports. The previous template lacked structure, sometimes resulting in incomplete or unclear security reports.

Why this change is needed

  • Better issue reporting: The updated template ensures that security reports include all necessary details, reducing the need for follow-up questions.
  • Prevents blank submissions: Adding config.yml disables blank issue submissions and enforces a structured format.
  • Improves maintainability: A clearer template helps maintainers assess and resolve security concerns more efficiently.

Type of change

Please delete any options that are not relevant.

  • Other:
    • Updated the security issue template with additional fields for better clarity.
    • Added config.yml to enforce the use of templates and prevent blank submissions.

Checklist

  • 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)

Screenshots (if any)

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.

- Renamed the file from `security.md` to `security_issue.yaml`.
- Updated the security issue template to provide clearer instructions for reporting vulnerabilities.
- Added structured sections for submitting and sharing GitHub Security Advisory URLs.
- Introduced warnings and notes to ensure no sensitive information is shared in the issue.
- Included a direct link to the "Create a New Security Advisory" page for convenience.
- Added `config.yml` to disable blank issues with `blank_issues_enabled: false`.

deleted:  .github/ISSUE_TEMPLATE/security.md
new file: .github/ISSUE_TEMPLATE/security_issue.yml
new file: .github/ISSUE_TEMPLATE/config.yml
@homelab-alpha homelab-alpha marked this pull request as ready for review February 3, 2025 06:16
Copy link
Collaborator

@CommanderStorm CommanderStorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, that is really usefull 🎉

@@ -0,0 +1,2 @@
---
blank_issues_enabled: false
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is amazing ❤️

@CommanderStorm CommanderStorm merged commit 44f5a89 into louislam:master Feb 6, 2025
18 checks passed
@homelab-alpha homelab-alpha deleted the enhance-security-issue-template branch February 6, 2025 12:44
@homelab-alpha homelab-alpha restored the enhance-security-issue-template branch February 6, 2025 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants