From 01e64c69cefaa8e4293e284f6d450f7c5cbc2b0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=C2=A0St=C4=99ch=C5=82y?= Date: Thu, 20 Jun 2024 15:33:08 -0400 Subject: [PATCH] chore: add issue and pr templates (#73) --- .github/ISSUE_TEMPLATE/bug_report.md | 27 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++++ .github/pull_request_template.md | 13 +++++++++++ 3 files changed, 60 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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e5224b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: 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. + +## How to Reproduce +Steps to reproduce the behavior, as minimal as possible. + +## Expected behavior +Description of what you expected to happen. + +## Actual behavior +Description of what actually happens. If needed may contain logs/outputs. + +## Environment:** + - OS: [e.g. OSX, Windows] + - Python version [e.g. 3.7.11] + +## 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 0000000..f56c9f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'enhancement' +assignees: '' + +--- + +## Is your feature request related to a problem? If so, please describe it. +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +## How you envision the solution +A clear and concise description of what you want to happen. + +## Describe alternatives you've considered +A clear and concise description of any alternative solutions or features you have considered. + +## Additional context +Add 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 new file mode 100644 index 0000000..67a0c1d --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,13 @@ +## Description + +Include description of feature this PR introduces or a bug that it fixes. Include the following information: + +- Context: why is it needed? In case of bug, what was the cause for the bug? +- Concise description of the implemented solution. +- If any dependencies are added, list them and justify why they are needed. + +## Please verify that you have completed the following steps + +- [ ] I have self-reviewed my code. +- [ ] I have included test cases validating introduced feature/fix. +- [ ] I have updated documentation. \ No newline at end of file