From 77eccb463753c36ae52fe906f7d6ef589ba47627 Mon Sep 17 00:00:00 2001 From: Alex Martynov Date: Tue, 27 Feb 2024 16:26:35 +0600 Subject: [PATCH] chore(SNP-903): add new PR and issues templates --- .github/ISSUE_TEMPLATE/bug_report.md | 9 ++- .github/ISSUE_TEMPLATE/config.yml | 5 ++ .../ISSUE_TEMPLATE/documentation_update.md | 13 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 19 +++-- .github/PULL_REQUEST_TEMPLATE.md | 74 ++----------------- .github/PULL_REQUEST_TEMPLATE/bug_fix.md | 9 +-- .../documentation_update.md | 9 +-- .github/PULL_REQUEST_TEMPLATE/new_feature.md | 9 +-- 8 files changed, 35 insertions(+), 112 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a9eae5d..9f615a5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,10 +1,13 @@ --- name: Bug report -about: Something is wrong with Surf DCM presets. +about: Something is wrong. title: "[BUG] " labels: bug --- - + ## Expected behavior @@ -52,4 +55,4 @@ What did you try to solve the problem? - [ ] Added isolated way to reproduce the bug. - [ ] Specified Flutter, Dart version and platforms. - [ ] Attached error code and logs. -- [ ] All unspecified fields in the Issue description deleted. +- [ ] All unspecified fields in the Issue description are deleted. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..6689749 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: SurfGear telegram chat + url: https://t.me/SurfGear + about: Please ask and answer questions here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation_update.md b/.github/ISSUE_TEMPLATE/documentation_update.md index 06cf266..3bb3aea 100644 --- a/.github/ISSUE_TEMPLATE/documentation_update.md +++ b/.github/ISSUE_TEMPLATE/documentation_update.md @@ -3,21 +3,18 @@ name: Documentation update about: Fixing a problem or improve in an existing docs page. labels: documentation --- - +## Specify package name + ## Describe what scenario you think is uncovered by the existing examples / articles - -A clear and concise description of the problem that you want explained. + ## Describe why existing examples / articles do not cover this case - -Explain which examples / articles you have seen before making this request, and -why they did not help you with your problem. + ## Additional context - -Add any other context or screenshots about the documentation request here. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 279b518..2c2f243 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,23 +1,22 @@ --- -name: Feature Request -about: I'd like Surf DCM presets to do something new. +name: Feature request +about: I'd like SurfGear team to do something new. labels: enhancement --- - +## Specify package name + ## What is the new or updated feature that you are suggesting? - -A clear and concise description of what you want to happen. + ## Why should this feature be included? - -Is your feature request related to a problem? Please describe a clear and concise description of what the problem is. If you investigated any alternative solutions please describe. + ## Additional context - -Please provide any other context or screenshots about the feature request here. + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 73138b8..ba5f1df 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,70 +1,6 @@ -## Related tasks - +Tap on "Preview" ⤴ - -## Dependence on other Pull Requests (optional) - - -## Background (optional) - - -## Changes - - -## Troubles (optional) - - -## Note (optional) - - -## Checklist for self-check -- [ ] Commits and PRs have been filed according to [the rules on the project](https://github.com/surfstudio/surf-flutter-app-template#workflow-in-a-repository). -- [ ] The author is marked as an assigne and assigned mandatory reviewers. -- [ ] Required labels marked -- [ ] Specified related tasks and/or related PRs. -- [ ] Specified Changes. -- [ ] Attached videos/screenshots demonstrating the fix/feature. -- [ ] All unspecified fields in the PR description deleted. -- [ ] New code covered by tests. - -## Checklist for reviewers -- [ ] CI passed successfully _(with a green check mark)_. -- [ ] PR is atomic, by volume no more than 400 (+-) corrected lines (not including codogen). - -Design: -- [ ] System design corresponds to the agreements on structure and architecture on the project. -- [ ] The code is decomposed into necessary and sufficient components. - -Functionality: -- [ ] The code solves the problem. -- [ ] Any changes to the user interface are reasonable and look good. - -Complexity: -- [ ] The code is clear, easy to read, functions are small, no more than 50 lines. -- [ ] The logic is not overcomplicated, there is no overengineering (no code sections that may be needed in the future, but no one knows about it). - -Tests: -- [ ] Updated or added tests for mandatory components. -- [ ] The tests are correct, helpful, and well designed/developed. - -Naming: -- [ ] The naming of variables, methods, classes and other components is understandable. - -Comments: -- [ ] The comments are understandable and helpful. - -Documentation: -- [ ] All labels are correct -- [ ] Technical documentation updated (after approval, updates last reviewer). +And choose one of the templates: +* [Bugfix PR](?expand=1&template=bug_fix.md) +* [New feature PR](?expand=1&template=new_feature.md) +* [Documentation update PR](?expand=1&template=documentation_update.md) \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md index 9b2411c..262175d 100644 --- a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md +++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md @@ -1,22 +1,17 @@ ---- -name: Bug fix -about: Fixing a problem with Surf DCM presets. ---- - - ## Checklist - [ ] Have you added an explanation of what your changes do and why you'd like us to include them? - [ ] Is there an existing issue for this PR? - - _link issue here_ + - _link issue here_ (use keywords like `fix`, `close`, `resolve` etc. if necessary) - [ ] Have the files been linted and formatted? - [ ] Have the docs been updated to match the changes in the PR? - [ ] Have the tests been updated to match the changes in the PR? +- [ ] Attached videos/screenshots demonstrating the fix/feature. - [ ] Have you run the tests locally to confirm they pass? ## Changes diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation_update.md b/.github/PULL_REQUEST_TEMPLATE/documentation_update.md index 82a4446..b4dd21d 100644 --- a/.github/PULL_REQUEST_TEMPLATE/documentation_update.md +++ b/.github/PULL_REQUEST_TEMPLATE/documentation_update.md @@ -1,19 +1,12 @@ ---- -name: Documentation update -about: Fixing a problem or improve in an existing docs page. -labels: documentation ---- - - ## Checklist - [ ] Is there an existing issue for this PR? - - _link issue here_ + - _link issue here_ (use keywords like `fix`, `close`, `resolve` etc. if necessary) - [ ] Have the files been linted and formatted? ## Changes diff --git a/.github/PULL_REQUEST_TEMPLATE/new_feature.md b/.github/PULL_REQUEST_TEMPLATE/new_feature.md index a6124ff..1625c60 100644 --- a/.github/PULL_REQUEST_TEMPLATE/new_feature.md +++ b/.github/PULL_REQUEST_TEMPLATE/new_feature.md @@ -1,22 +1,17 @@ ---- -name: New feature -labels: enhancement ---- - - ## Checklist - [ ] Have you added an explanation of what your changes do and why you'd like us to include them? - [ ] Is there an existing issue for this PR? - - _link issue here_ + - _link issue here_ (use keywords like `fix`, `close`, `resolve` etc. if necessary) - [ ] Have the files been linted and formatted? - [ ] Have the docs been updated to match the changes in the PR? - [ ] Have the tests been updated to match the changes in the PR? +- [ ] Attached videos/screenshots demonstrating the fix/feature. - [ ] Have you run the tests locally to confirm they pass? ## New Features