From 8f0e0ad5df1b5a4acece96f2177240ecc160de4f Mon Sep 17 00:00:00 2001 From: Marat Chukmarov Date: Tue, 18 May 2021 13:25:26 +0300 Subject: [PATCH] #449 adding issue templates, pr template (#472) * adding issue templates, pr template * fixed pr template Co-authored-by: marat --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 42 +++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 27 +++++++++++++++ .github/workflows/pr-checks.yaml | 15 ++++++++ 4 files changed, 115 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/pr-checks.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..0f821e5b689 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: "\U0001F41E Bug report" +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +(A clear and concise description of what the bug is.) + + +**Set up** +(How do you run the app?) + + +**Steps to Reproduce** +Steps to reproduce the behavior: + +1. + +**Expected behavior** +(A clear and concise description of what you expected to happen) + +**Screenshots** +(If applicable, add screenshots to help explain your problem) + + +**Additional context** +(Add any other context about the problem here) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..38947541fd3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,42 @@ +--- +name: "\U0001F680 Feature request" +about: Propose a new feature +title: '' +labels: enhancement +assignees: '' + +--- + +### Is your proposal related to a problem? + + + +(Write your answer here.) + +### Describe the solution you'd like + + + +(Describe your proposed solution here.) + +### Describe alternatives you've considered + + + +(Write your answer here.) + +### Additional context + + + +(Write your answer here.) \ 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 00000000000..d42d66aaa57 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ + +- [ ] **Breaking change?** (if so, please describe the impact and migration path for existing applications:) + +**What changes did you make?** (Give an overview) + +**Is there anything you'd like reviewers to focus on?** + + +**How Has This Been Tested?** (put an "X" next to an item) + +- [ ] No need to +- [ ] Manually(please, describe, when necessary) +- [ ] Unit checks +- [ ] Integration checks +- [ ] Covered by existing automation + + +**Checklist** (put an "X" next to an item, otherwise PR will fail) +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation (e.g. **ENVIRONMENT VARIABLES**) +- [ ] My changes generate no new warnings(e.g. Sonar is happy) +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged + +Check out [Contributing](https://github.com/provectus/kafka-ui/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://github.com/provectus/kafka-ui/blob/master/CODE-OF-CONDUCT.md) \ No newline at end of file diff --git a/.github/workflows/pr-checks.yaml b/.github/workflows/pr-checks.yaml new file mode 100644 index 00000000000..723966eb77d --- /dev/null +++ b/.github/workflows/pr-checks.yaml @@ -0,0 +1,15 @@ +name: 'PR Checklist checked' +on: + pull_request: + types: [opened, edited, synchronized, reopened] + +jobs: + task-check: + runs-on: ubuntu-latest + steps: + - uses: kentaro-m/task-completed-checker-action@v0.1.0 + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" + - uses: derkinderfietsen/pr-description-enforcer@v1 + with: + repo-token: '${{ secrets.GITHUB_TOKEN }}' \ No newline at end of file