Skip to content

Commit

Permalink
chore(SNP-903): add new PR and issues templates
Browse files Browse the repository at this point in the history
  • Loading branch information
martynov-alex committed Feb 27, 2024
1 parent ad50ded commit 77eccb4
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 112 deletions.
9 changes: 6 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
---
name: Bug report
about: Something is wrong with Surf DCM presets.
about: Something is wrong.
title: "[BUG] "
labels: bug
---

<!--
Thank you for contributing to our project!
This template is only for bugfix reports, otherwise please use another template.
-->
## Expected behavior
<!--Tell us what should happen-->

Expand Down Expand Up @@ -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.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 5 additions & 8 deletions .github/ISSUE_TEMPLATE/documentation_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,18 @@ name: Documentation update
about: Fixing a problem or improve in an existing docs page.
labels: documentation
---

<!--
Thank you for contributing to our project!
This template is only for documentation update reports, otherwise please use another template.
-->
## Specify package name
<!--Write the name of the package where you have problems-->

## Describe what scenario you think is uncovered by the existing examples / articles

A clear and concise description of the problem that you want explained.
<!--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.
<!--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.
<!--Add any other context or screenshots about the documentation request here.-->
19 changes: 9 additions & 10 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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
---

<!--
Thank you for contributing to our project!
This template is only for feature requests, otherwise please use another template.
Provide thoughtful commentary *and code samples* on what this feature means for your product. What will it allow you to do that you can't do today? How will it make current work-arounds straightforward? What potential bugs and edge cases does it help to avoid? etc. Please keep it product-centric.
Provide thoughtful commentary *and code samples* on what this feature means for your product. What will it allow you to do that you can't do today? How will it make current workarounds straightforward? What potential bugs and edge cases does it help to avoid? etc. Please keep it product-centric.
-->
## Specify package name
<!--Write the name of the package where you have problems-->

## What is the new or updated feature that you are suggesting?

A clear and concise description of what you want to happen.
<!--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.
<!--Is your feature request related to a problem? Please describe a clear and concise description of what the problem is. If you investigate any alternative solutions, please describe.-->

## Additional context

Please provide any other context or screenshots about the feature request here.
<!--Please provide any other context or screenshots about the feature request here.-->
74 changes: 5 additions & 69 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,6 @@
## Related tasks
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#related-tasks
-->
Tap on "Preview" ⤴


## Dependence on other Pull Requests (optional)
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#dependence-on-other-pull-requests-optional
-->

## Background (optional)
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#background-optional
-->

## Changes
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#changes
-->

## Troubles (optional)
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#troubles-optional
-->

## Note (optional)
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#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)
9 changes: 2 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
---
name: Bug fix
about: Fixing a problem with Surf DCM presets.
---

<!--
Thank you for contributing to our project!
Provide a description of your changes below and a general summary in the title.
Please look at the following checklist to ensure that your PR can be accepted quickly:
-->

## 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
Expand Down
9 changes: 1 addition & 8 deletions .github/PULL_REQUEST_TEMPLATE/documentation_update.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
---
name: Documentation update
about: Fixing a problem or improve in an existing docs page.
labels: documentation
---

<!--
Thank you for contributing to our project!
Provide a description of your changes below and a general summary in the title.
Please look at the following checklist to ensure that your PR can be accepted quickly:
-->

## 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
Expand Down
9 changes: 2 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE/new_feature.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
---
name: New feature
labels: enhancement
---

<!--
Thank you for contributing to our project!
Provide a description of your changes below and a general summary in the title.
Please look at the following checklist to ensure that your PR can be accepted quickly:
-->

## 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
Expand Down

0 comments on commit 77eccb4

Please sign in to comment.