From 78efe86c50bce7d75b2df8e6ebf4fbeb12334131 Mon Sep 17 00:00:00 2001 From: jinhojang6 Date: Fri, 10 Nov 2023 00:27:46 +0900 Subject: [PATCH] feat: add issue and pull request templates --- .github/ISSUE_TEMPLATE/bug_report.md | 44 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++++++++ .github/ISSUE_TEMPLATE/simple.md | 34 ++++++++++++++++++ .github/pull_request_template.md | 30 ++++++++++++++++ 4 files changed, 127 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/simple.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..1705504 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' +--- + +### Summary: + +[Provide a brief summary of the issue.] + +### Environment: + +- Operating System: +- Browser (If applicable): +- Project Version: +- Additional relevant information: + +### Steps to Reproduce: + +1. [First step] +2. [Second step] +3. [And so on…] + +### Expected Behavior: + +[Provide a detailed description of the expected behavior.] + +### Actual Behavior: + +[Provide a detailed description of the actual behavior you are experiencing.] + +### Screenshots (if applicable): + +[Attach screenshots to help illustrate the issue.] + +### Additional Information: + +[Any additional information, configuration, or data that might be necessary to reproduce the issue.] + +### Potential Solutions (if applicable): + +[Optional: Provide any thoughts or ideas you might have on potential solutions to the issue.] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..7a573c6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' +--- + +### Feature Request: + +[Quick summary of the feature you would like to be added.] + +### Why is this feature important? + +[Explain why you think this feature would be beneficial.] + +### How should it work? + +[Briefly describe how you envision this feature working, or how you would like it to be implemented.] diff --git a/.github/ISSUE_TEMPLATE/simple.md b/.github/ISSUE_TEMPLATE/simple.md new file mode 100644 index 0000000..4aa0240 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/simple.md @@ -0,0 +1,34 @@ +--- +name: Simple Template +about: Create an issue to help us improve +title: '' +labels: '' +assignees: '' +--- + +### Summary: + +[Provide a brief summary of the issue] + +### Environment: + +- Operating System: +- Browser (If applicable): +- Additional relevant information (If applicable): + +### Steps to Reproduce: + +1. [First step] +2. [And so on…] + +### Expected Behavior: + +[Description of the expected behavior] + +### Actual Behavior: + +[Description of the actual behavior you are experiencing] + +### Screenshots (if applicable): + +[Attach screenshots to help illustrate the issue] diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..eefb4d1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ +### Description: + +[Provide a brief description of the changes in the pull request.] + +### Related Issue(s): + +[Link to the related Issue(s), if any.] + +### Changes Included: + +- [ ] Bugfix (a change that fixes an issue) +- [ ] New feature (a change that adds new functionality) +- [ ] Refactoring (a change that improves code quality and/or architecture) +- [ ] Other (explain below) + +### Implementation Details: + +[Explain any new decisions made during the implementation of the changes.] + +### Testing: + +[Describe how the changes have been tested.] + +### Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] My changes generate no new warnings +- [ ] Any dependent changes have been merged and published in downstream modules