From cff7663117c63485a445cb14923f1ab03a3b891a Mon Sep 17 00:00:00 2001 From: 21120447 Date: Thu, 8 Aug 2024 10:31:36 +0700 Subject: [PATCH] :memo: docs: add github template --- .github/ISSUE_TEMPLATE/bug_report.yml | 82 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 35 +++++++++ .github/PULL_REQUEST_TEMPLATE.md | 32 +++++++++ 4 files changed, 150 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..faf0f8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,82 @@ +name: 🐛 Bug report +description: Something isn't working as expected? Here is the right place to report. +labels: ["bug"] + +body: + - type: markdown + attributes: + value: Please fill out each section below. This info allows maintainers to diagnose (and fix!) your issue as quickly as possible. Before opening a new issue, please search existing issues [here](https://github.com/saadpasta/developerFolio/issues). + + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior + value: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + + - type: input + attributes: + label: Is this responsiveness Issue + description: Write YES/NO in the box below + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + + - type: textarea + attributes: + label: Desktop + description: Please complete the following information + value: | + - OS: [e.g. iOS] + - Browser: [e.g. chrome, safari] + - Version: [e.g. 22] + validations: + required: false + + - type: textarea + attributes: + label: Smartphones + description: Please complete the following information + value: | + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + validations: + required: false + + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false \ 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..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..00c3201 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,35 @@ +name: 💡 Feature request +description: Got a suggestion for a new idea/feature ? +labels: ["enhancement"] +body: + - type: textarea + id: summary + attributes: + label: Summary + description: A brief explanation of the feature. + validations: + required: true + + - type: textarea + id: whatsnew + attributes: + label: What's new? + description: If the proposal involves a new component or a redesign of a previous component. + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: Motivation + description: Why are we doing this? What use cases does it support? What is the expected outcome? + validations: + required: true + + - type: textarea + id: extrainfo + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + validations: + required: false \ 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..27c6a83 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ +# Pull Request Template + +The code review checklist below is used for all pull requests. + +1. Review the list before submitting your pull request. +2. Leave the list intact for the code reviewer's use. + +## Description + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## Type of change + + + +- [ ] 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 not work as expected) +- [ ] This change requires a documentation update + +## Checklist + +- [ ] Latest code from master has been merged into the pull request branch +- [ ] Code is camelCased +- [ ] No linting issues +- [ ] Automated tests exist and pass + +## Thanks! + +:heart: \ No newline at end of file