-
-
Notifications
You must be signed in to change notification settings - Fork 360
adding some templates to be modified in review #569
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
7557499
adding some templates to be modified in review
leios c97d852
fixing a smallscale typo and adding leios to automatically be assigne…
leios f33ef4e
Update .github/ISSUE_TEMPLATE/CHAPTER_REQUEST.md
june128 7d4ebd5
Update .github/ISSUE_TEMPLATE/BUG_REPORT.md
june128 f18f949
Update .github/ISSUE_TEMPLATE/CHAPTER_REQUEST.md
june128 06b7509
Update .github/ISSUE_TEMPLATE/CHAPTER_REQUEST.md
june128 86efe43
Update .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
june128 7e9ba48
Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md
june128 eabce29
Update .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
june128 c173351
Update .github/PULL_REQUEST_TEMPLATE/CHAPTER_SUBMISSION_TEMPLATE.md
june128 3d0b877
Update .github/PULL_REQUEST_TEMPLATE/CHAPTER_SUBMISSION_TEMPLATE.md
june128 acd2d54
Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md
june128 d046b7b
Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md
june128 d7c3a42
Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md
june128 4cfa3c9
Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md
june128 12256b2
Update .github/PULL_REQUEST_TEMPLATE/CHAPTER_SUBMISSION_TEMPLATE.md
june128 8917723
Use markdown heading notation and add more structure.
june128 45f020b
Merge pull request #3 from julianschacher/PR_templates_use_markdown_h…
leios 427ec03
Apply suggestions from code review
june128 d09f7c6
Apply suggestions from code review
june128 e580e5c
Update .github/PULL_REQUEST_TEMPLATE/CODE_SUBMISSION_TEMPLATE.md
june128 bf068f0
Apply suggestions from code review
june128 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
labels: Problem | ||
--- | ||
|
||
<!-- | ||
Thanks for reporting a bug report to the Algorithm Archive! | ||
|
||
Please fill in the information below. | ||
|
||
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR | ||
--> | ||
|
||
# Bug Report | ||
|
||
## Description | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
### Steps to Reproduce | ||
|
||
Steps to reproduce the behavior: | ||
|
||
1. Go to '...' | ||
2. Click on '...' | ||
3. Scroll down to '...' | ||
4. See error | ||
|
||
### Expected behavior | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
## Screenshots | ||
|
||
If applicable, add screenshots to help explain your problem. | ||
|
||
## Environment | ||
|
||
<!--- Please complete the following information ---> | ||
|
||
- OS: [e.g. Ubuntu, iOS, Windows] | ||
- OS Version: [e.g. 16.04, 11.3.1, 10 09/2018] | ||
- Browser: [e.g. Chrome, Safari, Firefox] | ||
- Browser Version: [e.g. 22] | ||
|
||
## Additional context | ||
|
||
Add any other context about the problem here. | ||
|
||
|
||
<!--- Please leave the following section ---> | ||
|
||
## For Algorithm Archive Developers | ||
|
||
- [ ] The bug can be reproduced | ||
- [ ] The bug can be fixed (if not, please explain why not in a comment below) | ||
- [ ] There is a timeline to fix the bug | ||
- [ ] The bug has been fixed (Please link the PR) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
name: Chapter Request | ||
about: Requesting a new chapter to be in the Algorithm Archive | ||
--- | ||
|
||
<!-- | ||
Thanks for requesting a chapter for the Algorithm Archive! | ||
|
||
Please fill in the information below | ||
|
||
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR | ||
--> | ||
|
||
# Chapter Request | ||
|
||
## Description | ||
|
||
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. | ||
|
||
## Additional context | ||
|
||
Add any other reasons why this chapter should be a higher priority. | ||
leios marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Delete this section, if you don't think the chapter is of a high priority. | ||
|
||
|
||
<!--- Please leave the following section ---> | ||
|
||
## For Algorithm Archive Developers | ||
|
||
- [ ] 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.) | ||
- [ ] There is a timeline for when this chapter can be written | ||
- [ ] The chapter has been added to the [Master Overview](https://github.com/algorithm-archivists/algorithm-archive/projects/11) | ||
leios marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [ ] The chapter has been written (Please link the PR) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Feature Request | ||
about: Requesting a new feature to be in the Algorithm Archive | ||
--- | ||
|
||
<!-- | ||
Thanks for requesting a chapter for the Algorithm Archive! | ||
|
||
Please fill in the information below | ||
|
||
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR | ||
--> | ||
|
||
# Feature Request | ||
|
||
## Description | ||
|
||
A clear and concise description of what the desired feature is and how it would help, including any relevant screenshots / schematics. | ||
|
||
## Additional context | ||
|
||
Add any other reasons why this feature will help with the goals of the Algorithm Archive. | ||
|
||
|
||
<!--- Please leave the following section ---> | ||
|
||
## For Algorithm Archive Developers | ||
|
||
- [ ] 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) | ||
- [ ] There is a timeline for when this feature can be implemented | ||
- [ ] The feature has been added to the [Master Overview](https://github.com/algorithm-archivists/algorithm-archive/projects/11) | ||
- [ ] The feature has been implemented (Please link the PR) |
51 changes: 51 additions & 0 deletions
51
.github/PULL_REQUEST_TEMPLATE/CHAPTER_SUBMISSION_TEMPLATE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
name: Chapter submission | ||
about: Add a chapter or modify an existing chapter in the Algorithm Archive | ||
assignees: 'leios' | ||
--- | ||
|
||
<!-- | ||
Thanks for submitting a chapter to the Algorithm Archive! | ||
|
||
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: | ||
|
||
1. discussed the chapter with James Schloss (Leios) first and know where this chapter fits into the broader scope of the project | ||
2. edited the Markdown file with the appropriate line numbers for your submission | ||
3. built the algorithm archive with `gitbook install && gitbook serve` to make sure your code can be seen on your branch | ||
4. followed all necessary [style guidelines](https://github.com/algorithm-archivists/algorithm-archive/wiki/Code-style-guide) for the initial submission language, if available | ||
5. agreed to share your chapter under [CC BY-SA](https://creativecommons.org/licenses/by-sa/4.0/deed.en) | ||
|
||
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR | ||
--> | ||
|
||
# Chapter Submission | ||
|
||
## Description | ||
|
||
### The Chapter | ||
|
||
A clear and concise description of the chapter with relevant sources. | ||
|
||
### The Code | ||
|
||
A clear and concise description of the code with compilation instructions. | ||
|
||
## CC BY-SA notice | ||
|
||
<!--- Please replace AUTHOR with your actual name in the notice down below. ---> | ||
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)). | ||
|
||
(Anyone may use, share or remix this work, as long as they credit me and share any derivative work under this license.) | ||
|
||
|
||
<!--- Please leave the following section ---> | ||
|
||
## For Algorithm Archive Developers | ||
|
||
- [ ] The algorithm archive can be built locally | ||
- [ ] The markdown file has been edited with appropriate line numbers | ||
- [ ] There are appropriate images / animations to describe the chapter's algorithm, data structure, or method | ||
- [ ] The chapter opens up the Algorithm Archive to moving in a new direction or connects to other parts of the archive | ||
- [ ] All appropriate references have been cited or linked | ||
- [ ] The code conforms to the [style guidelines](https://github.com/algorithm-archivists/algorithm-archive/wiki/Code-style-guide) | ||
- [ ] 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Code submission | ||
about: Add code or modify existing code in the Algorithm Archive | ||
--- | ||
|
||
<!-- | ||
Thanks for submitting code to the Algorithm Archive! | ||
|
||
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: | ||
|
||
1. edited the Markdown file with the appropriate line numbers for your submission | ||
2. built the Algorithm Archive with `gitbook install && gitbook serve` to make sure your code can be seen on your branch | ||
3. followed all necessary [style guidelines](https://github.com/algorithm-archivists/algorithm-archive/wiki/Code-style-guide) for your language, if available | ||
|
||
If you would like to contact us, we are also available on Discord at https://discord.gg/2PEjsR | ||
--> | ||
|
||
# Code submission | ||
|
||
## Description | ||
|
||
A clear and concise description of the code with compilation instructions. | ||
|
||
|
||
<!--- Please leave the following section ---> | ||
|
||
## For Algorithm Archive Developers | ||
|
||
- [ ] There are no open PR's for this language implementation before this one | ||
- [ ] The Algorithm Archive can be built locally | ||
- [ ] The code conforms to the [style guidelines](https://github.com/algorithm-archivists/algorithm-archive/wiki/Code-style-guide) | ||
- [ ] The Markdown file has been edited with appropriate line numbers |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.