Skip to content

Commit 45f020b

Browse files
authored
Merge pull request #3 from julianschacher/PR_templates_use_markdown_heading_notation
Use markdown heading notation and add more structure.
2 parents 12256b2 + 8917723 commit 45f020b

File tree

5 files changed

+56
-20
lines changed

5 files changed

+56
-20
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,43 @@ Please fill in the information below.
1515
If you would like to contact us, we are also available on discord at https://discord.gg/2PEjsR
1616
-->
1717

18-
**Describe the bug**
18+
# Bug Report
19+
20+
## Description
21+
1922
A clear and concise description of what the bug is.
2023

21-
**To Reproduce**
24+
### Steps to Reproduce
25+
2226
Steps to reproduce the behavior:
2327
1. Go to '...'
2428
2. Click on '....'
2529
3. Scroll down to '....'
2630
4. See error
2731

28-
**Expected behavior**
32+
### Expected behavior
33+
2934
A clear and concise description of what you expected to happen.
3035

31-
**Screenshots**
36+
## Screenshots
37+
3238
If applicable, add screenshots to help explain your problem.
3339

34-
**Environment (please complete the following information):**
40+
## Environment (please complete the following information)
41+
3542
- OS: [e.g. Ubuntu, iOS, Windows]
3643
- OS Version: [e.g. 16.04, 11.3.1, 10 09/2018]
3744
- Browser [e.g. Chrome, Safari, Firefox]
3845
- Browser Version [e.g. 22]
3946

40-
**Additional context**
47+
## Additional context
48+
4149
Add any other context about the problem here.
4250

4351
<!--- Please leave this section --->
44-
**For Algorithm Archive Developers**
52+
53+
## For Algorithm Archive Developers
54+
4555
- [ ] The bug can be reproduced
4656
- [ ] The bug can be fixed (if not, please explain why not in a comment below)
4757
- [ ] There is a timeline to fix the bug

.github/ISSUE_TEMPLATE/CHAPTER_REQUEST.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,21 @@ Please fill in the information below
1515
If you would like to contact us, we are also available on discord at https://discord.gg/2PEjsR
1616
-->
1717

18-
**Describe the new algorithm, method, or data structure**
19-
A clear and concise description of what the new method would be about, including links to the relevant academic articles or sources.
18+
# Chapter Request
19+
20+
## Description
21+
22+
A clear and concise description of what the new algorithm, method or data structure would be about, including links to the relevant academic articles or sources.
23+
24+
## Additional context
2025

21-
**Additional context**
2226
Add any other reasons why this chapter should be a higher priority.
2327
Delete this section, if you don't think the chapter is of a high priority.
2428

2529
<!--- Please leave this section --->
26-
**For Algorithm Archive Developers**
30+
31+
## For Algorithm Archive Developers
32+
2733
- [ ] This chapter can be added to the [Master Overview](https://github.com/algorithm-archivists/algorithm-archive/projects/11) (if it cannot be, explain why in a comment below -- lack of sufficient technical sources, not novel enough, too ambitious, etc.)
2834
- [ ] There is a timeline for when this chapter can be written
2935
- [ ] The chapter has been added to the [Master Overview](https://github.com/algorithm-archivists/algorithm-archive/projects/11)

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,20 @@ Please fill in the information below
1515
If you would like to contact us, we are also available on discord at https://discord.gg/2PEjsR
1616
-->
1717

18-
**Describe the desired feature**
18+
# Feature Request
19+
20+
## Description
21+
1922
A clear and concise description of what the desired feature is and how it would help, including any relevant screenshots / schematics.
2023

21-
**Additional context**
24+
## Additional context
25+
2226
Add any other reasons why this feature will help with the goals of the Algorithm Archive
2327

2428
<!--- Please leave this section --->
25-
**For Algorithm Archive Developers**
29+
30+
## For Algorithm Archive Developers
31+
2632
- [ ] This feature can be added to the [Master Overview](https://github.com/algorithm-archivists/algorithm-archive/projects/11) (if it cannot be, explain why in a comment below -- lack of technical expertise, not relevant to the scope of this project, too ambitious)
2733
- [ ] There is a timeline for when this feature can be implemented
2834
- [ ] The feature has been added to the [Master Overview](https://github.com/algorithm-archivists/algorithm-archive/projects/11)

.github/PULL_REQUEST_TEMPLATE/CHAPTER_SUBMISSION_TEMPLATE.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,29 @@ Before continuing, please be sure you have read the [How to contribute guide for
2121
If you would like to contact us, we are also available on discord at https://discord.gg/2PEjsR
2222
-->
2323

24-
** Describe the chapter **
24+
# Chapter Submission
25+
26+
## Description
27+
28+
### The Chapter
29+
2530
A clear and concise description of the chapter with relevant sources
2631

27-
** Describe the code **
32+
### The Code
33+
2834
A clear and concise description of the code with compilation instructions
2935

30-
** CC BY-SA notice **
36+
## CC BY-SA notice
37+
3138
<!--- Please replace AUTHOR with your actual name in the notice down below. --->
3239
I, AUTHOR, the copyright holder of this work, irrevocably grant anyone the right to use this work, including derivatives created during the review process, under the Creative Commons Attribution ShareAlike 4.0 license ([legal code](https://creativecommons.org/licenses/by-sa/4.0/deed.en)).
3340

3441
(Anyone may use, share or remix this work, as long as they credit me and share any derivative work under this license.)
3542

3643
<!--- Please leave this section --->
37-
**For Algorithm Archive Developers**
44+
45+
## For Algorithm Archive Developers
46+
3847
- [ ] The algorithm archive can be built locally
3948
- [ ] The markdown file has been edited with appropriate line numbers
4049
- [ ] There are appropriate images / animations to describe the chapter's algorithm, data structure, or method

.github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,16 @@ Before continuing, please be sure you have read the [How to contribute guide for
1919
If you would like to contact us, we are also available on discord at https://discord.gg/2PEjsR
2020
-->
2121

22-
**Describe the code**
22+
# Code submission
23+
24+
## Description
25+
2326
A clear and concise description of the code with compilation instructions.
2427

2528
<!--- Please leave this section --->
26-
**For Algorithm Archive Developers**
29+
30+
## For Algorithm Archive Developers
31+
2732
- [ ] There are no open PR's for this language implementation before this one
2833
- [ ] The Algorithm Archive can be built locally
2934
- [ ] The code conforms to the [style guidelines](https://github.com/algorithm-archivists/algorithm-archive/wiki/Code-style-guide)

0 commit comments

Comments
 (0)