From b94a6c0c2f9b22d1a8c0df48f421843ee6cd870b Mon Sep 17 00:00:00 2001 From: vinogradsoft Date: Sun, 3 Dec 2023 04:44:35 +0300 Subject: [PATCH] Updated documents. --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 6 ++-- CODE_OF_CONDUCT.md | 2 +- PULL_REQUEST_TEMPLATE.md | 44 +++++++++++++++++++++++ SECURITY.md | 9 +++++ 5 files changed, 94 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 PULL_REQUEST_TEMPLATE.md create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..67fa70d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: vinogradsoft + +--- + + + +What are the steps to reproduce this issue? +------------------------------------------- +1. … +2. … +3. … + +What happens? +------------- +… + +What were you expecting to happen? +---------------------------------- +… + +Any logs, error output, etc? +---------------------------- + +… + +Any other comments? +------------------- +… + +What version you using? +---------------------------------------- +… diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..ff42776 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,9 +1,9 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' +title: "[ENHANCEMENT]" +labels: enhancement +assignees: vinogradsoft --- diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e63bfd4..4a2d101 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -60,7 +60,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -@xR2_D2x. +admin@vinogradsoft.com. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..741cc8a --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,44 @@ +# Pull Request Details + + + +## Description + + + +## Related Issue + + + + + + +## Context + + + +## How Has This Been Tested + + + + + +## Types of changes + + + +- [ ] Docs change / refactoring / dependency upgrade +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist + + + + +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have read the **CONTRIBUTING** document. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..e0f2e67 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,9 @@ +# Reporting security issues + +We value the contributions of the security research community. + +## Where should I report security issues? + +It is strongly recommended that you report all security issues privately via our email +sec@vinogradsoft.com rather than via GitHub. Please provide relevant technical details and reproduction steps to +expedite the investigation. \ No newline at end of file