Skip to content

Commit 9858052

Browse files
committed
Signed-off-by: Gbadebo Bello <gbahdeybohbello@gmail.com>
Added new templates for different type of issues that can be created.
1 parent 2fea2db commit 9858052

File tree

5 files changed

+72
-5
lines changed

5 files changed

+72
-5
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Create a new section
3+
about: For issues requesting for the need of an entirely new section(sidebars) in the documentation
4+
title: Create {section}
5+
labels: sections
6+
7+
---
8+
9+
<!-- This template is used for requesting for the addition of an entirely new section/sub-section in the current documentation. -->
10+
11+
12+
<!-- Thanks for filing an issue! Before hitting the button, please answer these questions.-->
13+
14+
# Create {section}
15+
16+
## Section Name: {section}
17+
<!-- What is this section called? -->
18+
19+
### Why do we need to create this section
20+
<!-- Tell us why it is important that this section is added to the documentation. -->
21+
22+
### What will this section contain?
23+
<!-- Tell us what will be included in this section that isn't already added to existing sections. -->
24+
25+
### Directory
26+
<!-- Will this be a section on it's own or it is going to be a sub-section? Can you provide a link to where this section will be added to? -->
27+
28+
### Sub-sections
29+
<!-- Does this section have sub-sections?
30+
If yes, please list the title of each sub-section in this format; -->
31+
32+
##### Sub-section one
33+
<!-- Sub-section one does Lorem ipsum dolor sit amet, consectetur... -->
34+
35+
##### Sub-section two
36+
<!-- Sub-section two does Lorem ipsum dolor sit amet, consectetur... -->
37+
38+
<!-- {Optional: add any further explanation if the above does not give room for enough context?} -->
39+
40+
## Helpful Resources
41+
<!-- {Optional: Add links to anything that might be helpful in understanding the need of this particular section} -->
42+
43+
<!-- Be ready for follow-up questions, and please respond in a timely manner. If we can't reproduce a bug or think a feature already exists, we might close your issue. If we're wrong, PLEASE feel free to reopen it and explain why. -->

.github/ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE/technical-issues.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
<!-- This form is for bug reports and feature requests ONLY! -->
1+
---
2+
name: Technical Issue
3+
about: For BUG REPORTS & FEATURE REQUESTS only!
4+
title: {title}
5+
labels: technical
6+
7+
---
8+
<!-- This template is for bug reports and feature requests ONLY! -->
9+
210
<!-- Thanks for filing an issue! Before hitting the button, please answer these questions.-->
311

412
## Is this a BUG REPORT or FEATURE REQUEST?
@@ -12,10 +20,7 @@ If this is a BUG REPORT, please:
1220
If this is a FEATURE REQUEST, please:
1321
- Describe *in detail* the feature/behavior/change you'd like to see.
1422
15-
In both cases, be ready for followup questions, and please respond in a timely
16-
manner. If we can't reproduce a bug or think a feature already exists, we
17-
might close your issue. If we're wrong, PLEASE feel free to reopen it and
18-
explain why.
23+
In both cases, be ready for follow-up questions, and please respond in a timely manner. If we can't reproduce a bug or think a feature already exists, we might close your issue. If we're wrong, PLEASE feel free to reopen it and explain why.
1924
-->
2025

2126
**What happened**:
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Update documentation
3+
about: For issues that require an update or improvement to the existing Litmus documentation
4+
title: {title}
5+
labels: updates
6+
7+
---
8+
9+
<!-- This template is used to report any type of errors(punctuations, grammatical, spelling, etc) found in the litmus documentation. More broadly speaking, it is used to request for fixes, updates, changes, or general improvements to the current Litmus documetation. -->
10+
11+
## What error was observed?
12+
<!-- This can be anything, a typo, spelling error, lack of clarity in specific places, etc. -->
13+
14+
## What improvement does this issue propose?
15+
<!-- Tell us what the improvement is and why it is better. Provide clarity in your explanation, give as much context as you can. Include links, screenshots(if necessary), and references. -->
16+
17+
## Helpful Resources
18+
<!-- {Optional: Add links to anything that might be helpful in understanding the need of this particular section} -->

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ website/i18n/*
1717
# Generated files
1818
website/.docusaurus
1919
website/.cache-loader
20+
website/build
2021

2122
# Misc
2223
.DS_Store

website/build/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)