Skip to content

Commit

Permalink
Add PR and issue templates (#1978)
Browse files Browse the repository at this point in the history
* Add issue templates

* Add SO and Discord to issue templates

* Add a PR template

* Fix Discord invite URL in PR contact link

* Title caps bug report template

* Simplify PR template

* Simplify bug report template

* Switch Bug Report and Feature Request issue templates order

* Update PULL_REQUEST_TEMPLATE.md

* Update 01_feature_request.md

* Update 02_bug_report.md

* Update config.yml

Co-authored-by: Seth Michael Larson <sethmichaellarson@gmail.com>
  • Loading branch information
hodbn and sethmlarson committed Sep 25, 2020
1 parent ed628df commit 6d38f17
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/01_feature_request.md
@@ -0,0 +1,26 @@
---
name: 🎁 Feature Request
about: Suggest a new feature
---

### Context

What are you trying to do?
How do you expect to do it?
Is it something you currently cannot do?
Is this related to an existing issue/problem?

### Alternatives

Can you achieve the same result doing it in an alternative way?
Is the alternative considerable?

### Duplicate

Has the feature been requested before?
If so, please provide a link to the issue.

### Contribution

Would you be willing to submit a PR?
_(Help can be provided if you need assistance submitting a PR)_
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/02_bug_report.md
@@ -0,0 +1,35 @@
---
name: 🐞 Bug Report
about: Something is broken
---

### Subject

Describe the issue here.

### Environment

Describe your environment.
At least, paste here the output of:

```python
import platform
import urllib3

print("OS", platform.platform())
print("Python", platform.python_version())
print("urllib3", urllib3.__version__)
```

### Steps to Reproduce

A simple and isolated way to reproduce the issue. A code snippet would be great.

### Expected Behavior

What should happen.

### Actual Behavior

What happens instead.
You may attach logs, packet captures, etc.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: 📚 Documentation
url: https://urllib3.readthedocs.io/en/latest/
about: Make sure you read the relevant docs
- name: ❓ Ask on StackOverflow
url: https://stackoverflow.com/questions/tagged/urllib3
about: Ask questions about usage in StackOverflow
- name: 💬 Ask the Community
url: https://discord.gg/CHEgCZN
about: Join urllib3's Discord server
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,8 @@
<!---
Thanks for your contribution! ♥️
If this is your first PR to urllib3 please review the Contributing Guide:
https://urllib3.readthedocs.io/en/latest/contributing.html
Adhering to the Contributing Guide means we can review, merge, and release your change faster! :)
--->

0 comments on commit 6d38f17

Please sign in to comment.