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

Fix: Updated security issue template #5604

Conversation

homelab-alpha
Copy link
Contributor

@homelab-alpha homelab-alpha commented Feb 6, 2025

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

Fix

@CommanderStorm, I had forgotten that guests can't assign someone without the proper permissions in GitHub. Therefore, I have adjusted the security issue template so that Louis Lam still receives a notification when there is a new security issue.

My apologies for the inconvenience.

Example outcome: security issue


GitHub Advisory URL for @ louislam

https://github.com/louislam/uptime-kuma/security/advisories/GHSA-8h5r-7t6l-q3kz


Note:

  • There is no space between the "@" symbol and "louislam" in the security issue. I don’t want to unnecessarily bother Louis Lam with this example.
  • The GHSA-8h5r-7t6l-q3kz is not real and is for demonstration purposes only.

Type of change

Please delete any options that are not relevant.

  • Other:
    • Updated the security issue template.

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.

Edit: Screenshot added after the pull request, successfully merged and closed for documentation purposes.

screenshot_security_issue_yml

- Updated the placeholder text to: "Please paste the GitHub Advisory URL here. Only the URL is required."
- Adjusted the label for the GitHub Advisory URL field to clearly indicate the intended recipient (@louislam).
- Improved the language to enhance clarity and remove ambiguity in the instructions.

modified: .github/ISSUE_TEMPLATE/security_issue.yml
@CommanderStorm CommanderStorm merged commit 7482d58 into louislam:master Feb 6, 2025
18 checks passed
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

@homelab-alpha homelab-alpha deleted the fix-enhance-security-issue-template branch February 6, 2025 18:42
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