Skip to content

Commit fa4a998

Browse files
leiosjune128
leios
authored and
june128
committed
adding some templates to be modified in review (algorithm-archivists#569)
* adding some templates to be modified in review * fixing a smallscale typo and adding leios to automatically be assigned for chapter requests and submissions. * Update .github/ISSUE_TEMPLATE/CHAPTER_REQUEST.md Co-Authored-By: leios <[email protected]> * Update .github/ISSUE_TEMPLATE/BUG_REPORT.md Co-Authored-By: leios <[email protected]> * Update .github/ISSUE_TEMPLATE/CHAPTER_REQUEST.md Co-Authored-By: leios <[email protected]> * Update .github/ISSUE_TEMPLATE/CHAPTER_REQUEST.md Co-Authored-By: leios <[email protected]> * Update .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md Co-Authored-By: leios <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md Co-Authored-By: leios <[email protected]> * Update .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md Co-Authored-By: leios <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE/CHAPTER_SUBMISSION_TEMPLATE.md Co-Authored-By: leios <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE/CHAPTER_SUBMISSION_TEMPLATE.md Co-Authored-By: leios <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md Co-Authored-By: leios <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md Co-Authored-By: leios <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md Co-Authored-By: leios <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md Co-Authored-By: leios <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE/CHAPTER_SUBMISSION_TEMPLATE.md Co-Authored-By: leios <[email protected]> * Use markdown heading notation and add more structure. * Apply suggestions from code review Co-Authored-By: leios <[email protected]> * Apply suggestions from code review Co-Authored-By: leios <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md Co-Authored-By: leios <[email protected]> * Apply suggestions from code review Co-Authored-By: leios <[email protected]>
1 parent ca58683 commit fa4a998

File tree

5 files changed

+207
-0
lines changed

5 files changed

+207
-0
lines changed

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
labels: Problem
5+
---
6+
7+
<!--
8+
Thanks for reporting a bug report to the Algorithm Archive!
9+
10+
Please fill in the information below.
11+
12+
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR
13+
-->
14+
15+
# Bug Report
16+
17+
## Description
18+
19+
A clear and concise description of what the bug is.
20+
21+
### Steps to Reproduce
22+
23+
Steps to reproduce the behavior:
24+
25+
1. Go to '...'
26+
2. Click on '...'
27+
3. Scroll down to '...'
28+
4. See error
29+
30+
### Expected behavior
31+
32+
A clear and concise description of what you expected to happen.
33+
34+
## Screenshots
35+
36+
If applicable, add screenshots to help explain your problem.
37+
38+
## Environment
39+
40+
<!--- Please complete the following information --->
41+
42+
- OS: [e.g. Ubuntu, iOS, Windows]
43+
- OS Version: [e.g. 16.04, 11.3.1, 10 09/2018]
44+
- Browser: [e.g. Chrome, Safari, Firefox]
45+
- Browser Version: [e.g. 22]
46+
47+
## Additional context
48+
49+
Add any other context about the problem here.
50+
51+
52+
<!--- Please leave the following section --->
53+
54+
## For Algorithm Archive Developers
55+
56+
- [ ] The bug can be reproduced
57+
- [ ] The bug can be fixed (if not, please explain why not in a comment below)
58+
- [ ] There is a timeline to fix the bug
59+
- [ ] The bug has been fixed (Please link the PR)

‎.github/ISSUE_TEMPLATE/CHAPTER_REQUEST.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Chapter Request
3+
about: Requesting a new chapter to be in the Algorithm Archive
4+
---
5+
6+
<!--
7+
Thanks for requesting a chapter for the Algorithm Archive!
8+
9+
Please fill in the information below
10+
11+
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR
12+
-->
13+
14+
# Chapter Request
15+
16+
## Description
17+
18+
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.
19+
20+
## Additional context
21+
22+
Add any other reasons why this chapter should be a higher priority.
23+
Delete this section, if you don't think the chapter is of a high priority.
24+
25+
26+
<!--- Please leave the following section --->
27+
28+
## For Algorithm Archive Developers
29+
30+
- [ ] 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.)
31+
- [ ] There is a timeline for when this chapter can be written
32+
- [ ] The chapter has been added to the [Master Overview](https://github.com/algorithm-archivists/algorithm-archive/projects/11)
33+
- [ ] The chapter has been written (Please link the PR)

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature Request
3+
about: Requesting a new feature to be in the Algorithm Archive
4+
---
5+
6+
<!--
7+
Thanks for requesting a chapter for the Algorithm Archive!
8+
9+
Please fill in the information below
10+
11+
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR
12+
-->
13+
14+
# Feature Request
15+
16+
## Description
17+
18+
A clear and concise description of what the desired feature is and how it would help, including any relevant screenshots / schematics.
19+
20+
## Additional context
21+
22+
Add any other reasons why this feature will help with the goals of the Algorithm Archive.
23+
24+
25+
<!--- Please leave the following section --->
26+
27+
## For Algorithm Archive Developers
28+
29+
- [ ] 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)
30+
- [ ] There is a timeline for when this feature can be implemented
31+
- [ ] The feature has been added to the [Master Overview](https://github.com/algorithm-archivists/algorithm-archive/projects/11)
32+
- [ ] The feature has been implemented (Please link the PR)

‎.github/PULL_REQUEST_TEMPLATE/CHAPTER_SUBMISSION_TEMPLATE.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Chapter submission
3+
about: Add a chapter or modify an existing chapter in the Algorithm Archive
4+
assignees: 'leios'
5+
---
6+
7+
<!--
8+
Thanks for submitting a chapter to the Algorithm Archive!
9+
10+
Before continuing, please be sure you have read the [How to contribute guide for chapter submission](https://github.com/algorithm-archivists/algorithm-archive/wiki/Chapter-submission) and have:
11+
12+
1. discussed the chapter with James Schloss (Leios) first and know where this chapter fits into the broader scope of the project
13+
2. edited the Markdown file with the appropriate line numbers for your submission
14+
3. built the algorithm archive with `gitbook install && gitbook serve` to make sure your code can be seen on your branch
15+
4. followed all necessary [style guidelines](https://github.com/algorithm-archivists/algorithm-archive/wiki/Code-style-guide) for the initial submission language, if available
16+
5. agreed to share your chapter under [CC BY-SA](https://creativecommons.org/licenses/by-sa/4.0/deed.en)
17+
18+
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR
19+
-->
20+
21+
# Chapter Submission
22+
23+
## Description
24+
25+
### The Chapter
26+
27+
A clear and concise description of the chapter with relevant sources.
28+
29+
### The Code
30+
31+
A clear and concise description of the code with compilation instructions.
32+
33+
## CC BY-SA notice
34+
35+
<!--- Please replace AUTHOR with your actual name in the notice down below. --->
36+
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)).
37+
38+
(Anyone may use, share or remix this work, as long as they credit me and share any derivative work under this license.)
39+
40+
41+
<!--- Please leave the following section --->
42+
43+
## For Algorithm Archive Developers
44+
45+
- [ ] The algorithm archive can be built locally
46+
- [ ] The markdown file has been edited with appropriate line numbers
47+
- [ ] There are appropriate images / animations to describe the chapter's algorithm, data structure, or method
48+
- [ ] The chapter opens up the Algorithm Archive to moving in a new direction or connects to other parts of the archive
49+
- [ ] All appropriate references have been cited or linked
50+
- [ ] The code conforms to the [style guidelines](https://github.com/algorithm-archivists/algorithm-archive/wiki/Code-style-guide)
51+
- [ ] The CC BY-SA license is an appropriate modification of the license found in `cc/license.txt` and has all images and graphics, text, code, and auxiliary materials licensed appropriately

‎.github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Code submission
3+
about: Add code or modify existing code in the Algorithm Archive
4+
---
5+
6+
<!--
7+
Thanks for submitting code to the Algorithm Archive!
8+
9+
Before continuing, please be sure you have read the [How to contribute guide for code submission](https://github.com/algorithm-archivists/algorithm-archive/wiki/How-to-Contribute#step-3---submitting-code) and have:
10+
11+
1. edited the Markdown file with the appropriate line numbers for your submission
12+
2. built the Algorithm Archive with `gitbook install && gitbook serve` to make sure your code can be seen on your branch
13+
3. followed all necessary [style guidelines](https://github.com/algorithm-archivists/algorithm-archive/wiki/Code-style-guide) for your language, if available
14+
15+
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR
16+
-->
17+
18+
# Code submission
19+
20+
## Description
21+
22+
A clear and concise description of the code with compilation instructions.
23+
24+
25+
<!--- Please leave the following section --->
26+
27+
## For Algorithm Archive Developers
28+
29+
- [ ] There are no open PR's for this language implementation before this one
30+
- [ ] The Algorithm Archive can be built locally
31+
- [ ] The code conforms to the [style guidelines](https://github.com/algorithm-archivists/algorithm-archive/wiki/Code-style-guide)
32+
- [ ] The Markdown file has been edited with appropriate line numbers

0 commit comments

Comments
 (0)