From dd622d88374f8cc5476044c0a35669a1343231f6 Mon Sep 17 00:00:00 2001 From: Aymen Kouskoussi Date: Sat, 3 May 2025 09:20:13 +0200 Subject: [PATCH] Add security policy, pull request template, and new issue templates (feature request, question) --- .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 11 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++++++++++++ .github/SECURITY.md | 11 +++++++++++ 4 files changed, 61 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..01a8042 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature Request +description: Suggest an idea for this project +labels: enhancement +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..76cb947 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,11 @@ +--- +name: Question +about: Ask a question or request support +labels: question +--- + +**Your question** +Please describe your question or what you need help with. + +**Context** +Add any other context or details that might help us answer your question. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..a531761 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +# Pull Request Template + +Thank you for your contribution! + +Please fill out the following checklist and provide all relevant information to help us review your pull request. + +## Description + +Please include a summary of the change and which issue is fixed (if any). Also describe your motivation and context. + +Fixes #(issue) + +## Checklist +- [ ] My code follows the project style and guidelines +- [ ] I have performed a self-review of my code +- [ ] I have tested the changes and they work as expected +- [ ] I have added tests that prove my fix is effective or that my feature works (if applicable) +- [ ] I have added necessary documentation (if appropriate) + +## Additional Information + +Please add any other information or screenshots that may help the reviewers. \ No newline at end of file diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..97de88d --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,11 @@ +# Security Policy + +## Reporting a Vulnerability + +If you discover a security vulnerability, please report it by emailing the project maintainers at [your-email@example.com]. + +- Do **not** create a public issue for security vulnerabilities. +- Provide as much information as possible to help us understand and address the issue quickly. +- We will acknowledge your report within 3 business days and strive to resolve all security issues promptly. + +Thank you for helping keep this project and its users safe! \ No newline at end of file