Incorporate open source template#116
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request synchronizes the repository with an open source template standard, updating GitHub templates and markdown documentation files. The changes modernize the project's documentation structure and replace markdown-based GitHub templates with YAML-based forms for better structure and validation.
- Adds new standardized SECURITY.md file with vulnerability reporting guidelines
- Restructures README.md with improved organization including a table of contents and moved Requirements section
- Updates CONTRIBUTING.md and CODE_OF_CONDUCT.md with more comprehensive guidelines
- Replaces markdown-based GitHub issue templates with structured YAML forms for bug reports and feature requests
- Replaces old pull request template with a new standardized version
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | New file providing security vulnerability reporting guidelines and contact information |
| README.md | Restructured with added Description section, table of contents, moved Requirements section before Getting Started, and updated Contributing section with references to new templates |
| CONTRIBUTING.md | Completely rewritten with expanded contribution guidelines, clearer process steps, and references to code of conduct |
| CODE_OF_CONDUCT.md | Updated from Contributor Covenant v2.0 to v1.4 with simplified enforcement guidelines and updated contact email |
| .github/pull_request_template.md | New standardized pull request template with sections for summary, change types, checklist, and additional notes |
| .github/PULL_REQUEST_TEMPLATE | Old pull request template removed in favor of new standardized version |
| .github/ISSUE_TEMPLATE/feature_request.yml | New YAML-based feature request form with structured fields for description, additional information, and alternatives |
| .github/ISSUE_TEMPLATE/feature_request.md | Old markdown-based feature request template removed |
| .github/ISSUE_TEMPLATE/bug_report.yml | New YAML-based bug report form with structured fields for description, environment, reproduction steps, expected behavior, and additional information |
| .github/ISSUE_TEMPLATE/bug_report.md | Old markdown-based bug report template removed |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📄 Context
Sync with open source template (standard) for repo. Nothing major changed. Readme is refactored a bit.
📝 Changes
Changes to Github templates, markdown info files and readme
📎 Related PR
🚫 Breaking
🛠️ How to test
⏱️ Next steps