Skip to content

Commit 3347644

Browse files
authored
Merge pull request #1649 from jemarq04/feat/update-issue-templates
Update GitHub issue templates
2 parents 718ceff + 960ed00 commit 3347644

4 files changed

Lines changed: 48 additions & 34 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 21 deletions
This file was deleted.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
type: bug
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for contributing to the PokéAPI project. To make sure we're effective, please check the following:
9+
10+
- Make sure your issue hasn't already been submitted on the issues tab. (It has search functionality!)
11+
- We're still missing data! If you notice anything is missing, check our current issues to make sure no one else has noticed it as well.
12+
- Provide a clear description of the issue.
13+
- Provide a clear description of the expected behavior.
14+
- Provide a clear description of the steps to reproduce.
15+
16+
Thank you!
17+
- type: textarea
18+
attributes:
19+
label: Describe the Bug
20+
description: Please describe the issue you're seeing and what you'd expect to find. If you're correcting data, please provide any sources that back up what you're mentioning.
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Steps to Reproduce
26+
description: Please describe how to reproduce the bug (e.g. the file or PokéAPI website that shows the problem). For missing data, you can point to existing endpoints that should have it, or just put "Missing data".
27+
validations:
28+
required: true
29+
- type: dropdown
30+
attributes:
31+
label: Resolving the Bug
32+
description: A lot of issues can be resolved with a quick PR to the API -- if that is the case here, feel free to skip this step and open the PR! If you'd like to open it to discussion first or simply make an issue to keep track of the timeline, continue here.
33+
options:
34+
- Anyone is open to making a PR for this issue.
35+
- I plan on making a PR for this issue.
36+
default: 0

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
21
blank_issues_enabled: false
32
contact_links:
4-
- name: Question
5-
url: https://stackoverflow.com/search?q=%22pokeapi%22
6-
about: Please ask and answer questions here
7-
- name: Slack invitation link
8-
url: https://pokeapi-slack-invite.herokuapp.com/
9-
about: If you are not a member of our Slack, use this invitation link to be invited to join it
10-
- name: Slack
11-
url: https://pokeapi.slack.com/messages
12-
about: Browse our Slack
3+
- name: Questions
4+
url: https://github.com/pokeapi/pokeapi/discussions
5+
about: Any questions or comments can be posted to our discussions page
6+
- name: Join our Discord
7+
url: https://discord.com/invite/BpjJcKK4TC
8+
about: To connect with other PokeAPI users and contributors, join our Discord
Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
54
---
65

76
<!--
8-
Please search existing issues to avoid creating duplicates.
7+
Thanks for contributing to the PokéAPI project. To make sure we're effective,
8+
please check the following:
99
10-
Describe the feature you'd like.
10+
- Make sure your issue hasn't already been submitted on the issues tab. (It has
11+
search functionality!)
12+
- If this is in regards to missing data, please open a bug report instead.
13+
- Describe the feature you'd like.
1114
1215
Thank you!
1316
-->

0 commit comments

Comments
 (0)