Skip to content

Chore: Migrate issue templates to YAML, update PR template, and add SECURITY.md#29

Merged
Brian06 merged 2 commits into
ltvco:mainfrom
cariasj03:chore_issue-pr-template-update
Jul 7, 2025
Merged

Chore: Migrate issue templates to YAML, update PR template, and add SECURITY.md#29
Brian06 merged 2 commits into
ltvco:mainfrom
cariasj03:chore_issue-pr-template-update

Conversation

@cariasj03

@cariasj03 cariasj03 commented Jul 2, 2025

Copy link
Copy Markdown
Contributor

Description

This PR updates the issue and pull request templates to improve clarity and consistency, and adds a SECURITY.md file to enable GitHub's built-in vulnerability reporting flow. Issue templates were migrated from .md files to .yml format to support structured forms and better guidance for contributors.

Motivation & Context

The previous issue templates were freeform Markdown and lacked validation or structure. Migrating to YAML-based forms provides a better user experience when submitting issues and ensures key information is consistently collected.
Adding a SECURITY.md file enables the "Report a security vulnerability" option on the Issues page and provides a clear channel for responsible disclosure.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Refactoring (non-breaking change with no user-facing impact)
  • Breaking change (fix or feature that changes existing behavior)
  • Documentation update

Related Issues

N/A

Testing

Changes are limited to documentation. Verified that:

  • External file links (CONTRIBUTING.md) are accessible from the GitHub UI preview.
  • Using the YAML extension for VS Code to validate that all .yml files are free of syntax errors.
  • Markdown renders as expected in GitHub.

Checklist

  • I have read the contributing guidelines
  • My code follows the style guidelines for this project
  • I have commented important parts of the code
  • I have made necessary updates to the documentation
  • I have added or updated tests to prove my changes work
  • All tests pass locally
  • This PR does not introduce new warnings or console errors

Additional Notes

The content of the SECURITY.md file was discussed with and approved by our SecOps engineer, @dagerzuniga, to ensure alignment with internal security reporting processes.

@cariasj03 cariasj03 self-assigned this Jul 2, 2025
@cariasj03 cariasj03 added the documentation Improvements or additions to documentation label Jul 2, 2025
@Brian06 Brian06 requested a review from dagerzuniga July 2, 2025 19:12
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/ISSUE_TEMPLATE/bug_report.yml
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
@cariasj03 cariasj03 requested review from Brian06, KennethCalvo and alsoto25 and removed request for KennethCalvo July 3, 2025 18:41
@Brian06 Brian06 merged commit ce1b6fa into ltvco:main Jul 7, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants