Skip to content

Commit

Permalink
chore(github): update issue and pr templates
Browse files Browse the repository at this point in the history
  • Loading branch information
WSH032 committed Nov 29, 2023
1 parent 46a0a3a commit 556227c
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- copy from: https://github.com/encode/starlette/blob/master/.github/pull_request_template.md -->

<!-- Thanks for contributing 💚
Given this is a project maintained by volunteers, please read this template to not waste your time, or ours! 😁 -->

# Summary

<!-- Write a small summary about what is happening here. -->

# 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.

0 comments on commit 556227c

Please sign in to comment.