diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..03fe30b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,41 @@ +--- +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. + +## To Reproduce + +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Configuration + +```shell +# use `pip freeze` to list all deps +pip freeze +``` + +- Python version: +- OS version: +- deps version: +- ... + +## Additional context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..e138526 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: I have a question 🤔 + url: https://github.com/WSH032/fastapi-proxy-lib/discussions + about: If you have any question that's not clearly a bug, please open a discussion first. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..dca4a5a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,32 @@ +--- +name: Feature request 💡 +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +## Have you discussed it? + +- [ ] I have discussed this feature request in discussions, and developers ask me directly to create an issue here. + +## Describe your feature request + +A clear and concise description of what the feature is. + +## Is your feature request related to a problem? Please describe + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +## Describe the solution you'd like + +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've considered. + +## Additional context + +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..db8c33a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ + + + + +# Summary + + + +# Checklist + +- [ ] I've read `CONTRIBUTING.md`. +- [ ] I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!) +- [ ] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change. +- [ ] I've updated the documentation accordingly.