Skip to content

chore: add MIT LICENSE and SECURITY.md #4

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.

Sign up for GitHub

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

Merged
donny-devops merged 1 commit into from
Jul 7, 2026
Merged

chore: add MIT LICENSE and SECURITY.md #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Adonis Jimenez

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
42 changes: 42 additions & 0 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Security Policy

## Supported Versions

Security updates are applied to the latest released version on the default
branch. Older tags are not guaranteed to receive fixes.

| Version | Supported |
| -------------- | ------------------ |
| Latest (main) | :white_check_mark: |
| Older releases | :x: |

## Reporting a Vulnerability

**Please do not report security vulnerabilities through public GitHub issues.**

Instead, report them privately using one of the following channels:

1. **GitHub Security Advisories** — use the
[private vulnerability reporting](../../security/advisories/new) feature on
this repository (preferred).
Comment on lines +19 to +21

@gemini-code-assist gemini-code-assist Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The relative link ../../security/advisories/new will break when viewed from the repository's Security tab (rendered at /security/policy), as it resolves to /<owner>/security/advisories/new instead of /<owner>/<repo>/security/advisories/new.

In GitHub Markdown, links starting with a leading slash / are automatically resolved relative to the repository root. Changing the link to /security/advisories/new will make it work correctly in both the file viewer and the Security tab, while remaining fully reusable across different repositories.

Suggested change
1. **GitHub Security Advisories** — use the
[private vulnerability reporting](../../security/advisories/new) feature on
this repository (preferred).
1. **GitHub Security Advisories** — use the
[private vulnerability reporting](/security/advisories/new) feature on
this repository (preferred).

Comment on lines +19 to +21

@qodo-code-review qodo-code-review Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Informational

1. Confusing advisory link 🐞 Bug ⚙ Maintainability

SECURITY.md uses a "../../" relative link to the Security Advisories reporting URL, which is unclear
and may not resolve correctly outside GitHub’s renderer/path-rewriting. This can make the reporting
instructions harder to follow and more fragile to file moves.
Agent Prompt 
## Issue description
`SECURITY.md` links to GitHub private vulnerability reporting using `../../security/advisories/new`, which is a confusing path escape from a repo-root document and is less portable across renderers.

## Issue Context
This is a documentation-only PR; fix should keep the same destination but make the link unambiguous.

## Fix Focus Areas
- SECURITY.md[19-21]

## Suggested change
Replace the link target with one of:
- an absolute GitHub path: `/security/advisories/new`
- or the full URL: `https://github.com/<owner>/<repo>/security/advisories/new`

(Prefer `/security/advisories/new` to avoid hardcoding owner/repo.)

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

2. **Email** — send details to **adonis-jimenez@outlook.com** with the subject
line `SECURITY: <repository-name>`.

Please include as much of the following as possible:

- A description of the vulnerability and its potential impact
- Steps to reproduce or a proof of concept
- Affected version(s), configuration, or environment
- Any suggested remediation

## Response Targets

| Stage | Target |
| --------------------- | -------------------------- |
| Acknowledgement | within 48 hours |
| Initial assessment | within 5 business days |
| Fix / mitigation plan | communicated after triage |

We follow a coordinated disclosure process. Please give us a reasonable
window to remediate before any public disclosure. We are happy to credit
reporters who wish to be acknowledged.
Loading