History

Merge pull request #1503 from MasterEnoc/issues-template

Add new issues templates

Simon Legner committed 5 years ago

Commit cba8e5e2 parents d3e6977 7ae327a5 files · +121 −10Browse files

Unified · Split

5 files
  1. .github/ISSUE_TEMPLATE.md +0 −10
  2. .github/ISSUE_TEMPLATE/bug_report.md +44 −0
  3. .github/ISSUE_TEMPLATE/config.yml +8 −0
  4. .github/ISSUE_TEMPLATE/documentation_bug.md +33 −0
  5. .github/ISSUE_TEMPLATE/feature_request.md +36 −0
.github/ISSUE_TEMPLATE.md+0−10
@@ -1,10 +0,0 @@
1<!--
2 ⚠ Please check the automated versions report before reporting outdated docs:
3 https://github.com/freeCodeCamp/devdocs/issues?q="Documentation+versions+report"
4
5 ⚠ Please read the contributing guidelines before opening an issue:
6 https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md
7
8 Go here to request a new documentation:
9 https://trello.com/b/6BmTulfx/devdocs-documentation
10-->
.github/ISSUE_TEMPLATE/bug_report.md+44−0
@@ -0,0 +1,44 @@
1---
2name: Bug report
3about: Create a report to help us improve Devdocs
4title: ''
5labels: 'bug'
6assignees: ''
7---
8
9<!--
10If possible fill each section
11-->
12
13# Bug report
14
15<!--
16Verify this steps before writing a new issue:
17
18 - Search for existing issues; it's possible someone has already encountered this bug.
19-->
20
21## OS information
22
23<!--
24What operating system and browser version are you using?
25-->
26
27## Steps to reproduce
28
29<!--
30Write the steps to reproduce this bug or write a description about when and how you
31encountered it
32-->
33
34## More resources
35
36<!--
37Add images, GIFs, screenshot, console output or any other resource that might help to undestand this bug
38-->
39
40## Possible fix
41
42<!--
43If you have an idea how to fix this you can write here
44-->
.github/ISSUE_TEMPLATE/config.yml+8−0
@@ -0,0 +1,8 @@
1blank_issues_enabled: false
2contact_links:
3 - name: Question
4 about: "Ask questions and have discussions on Gitter"
5 url: "https://gitter.im/FreeCodeCamp/DevDocs"
6 - name: New Documentation
7 about: "Request a new documentation on Trello"
8 url: "https://trello.com/b/6BmTulfx/devdocs-documentation"
.github/ISSUE_TEMPLATE/documentation_bug.md+33−0
@@ -0,0 +1,33 @@
1---
2name: Documentation bug
3about: Report a problem with a specific documentation
4title: ''
5labels: 'docs/improvement'
6assignees: ''
7---
8
9<!--
10If possible fill each section
11-->
12
13# Documentation style bug
14
15<!--
16 - Search for existing issues
17 https://github.com/freeCodeCamp/devdocs/labels/docs%2Fimprovement
18-->
19
20## Summary
21<!--
22Add a description about how the documentation should be
23-->
24
25## Actual style
26<!--
27Add images or urls of the miss-formatted devdocs documentation
28-->
29
30## Expected style
31<!--
32Add images showing the expected style or urls of the source page
33-->
.github/ISSUE_TEMPLATE/feature_request.md+36−0
@@ -0,0 +1,36 @@
1---
2name: Feature request
3about: Suggest a new feature
4title: ''
5labels: 'feature'
6assignees: ''
7---
8
9<!--
10If possible fill each section
11-->
12
13# Feature request
14
15<!--
16Verify this steps before suggeting a new feature:
17
18 - Check if anyone has suggested this feature before
19 https://github.com/freeCodeCamp/devdocs/labels/feature
20
21 - Make sure your feature fits DevDocs' vision
22 https://github.com/freeCodeCamp/devdocs/blob/master/README.md#vision
23-->
24
25## Summary
26
27<!--
28Write a description of this feature and write why it should be added to Devdocs
29-->
30
31## Examples
32
33<!--
34If you have seen this feature before you can add images, URLs, gifs and any other
35resouce that might help to undestand how this feature works
36-->

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t