Skip to content

Commit

Permalink
Add default PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
Parker Johansen committed Oct 7, 2020
1 parent 2b67a39 commit 22de3d0
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 2 deletions.
62 changes: 62 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
Congrats on taking the first step to contributing to the Sample Programs repository maintained by [The Renegade Coder][renegade-coder]!
For simplicity, please make sure that your pull request includes one and only one contribution.

Please fill _one_ of the sections below as applicable.
Please also add any other relevant information to the Notes section at the bottom.
You may delete or just ignore any other sections.
For more information please refer to our [contributing documentation][contributing]

## I Am Adding a New Code Snippet in an Existing Language

- [ ] I fixed #your-issue-number-here
- [ ] I named the pull request using `Add {PROJECT} in {LANGUAGE}` format
- [ ] I created/updated the language README (see [contributing documentation][contributing-readme])
- [ ] I added the sample program name to the README
- [ ] I added fun facts (i.e. debut developer, typing, etc.)
- [ ] I added reference link(s) to the README
- [ ] I added solution citations when necessary (see [plagiarism][contributing-plagiarism])


## I Am Adding a New Code Snippet in a New Language

- [ ] I fixed #your-issue-number-here
- [ ] I named the pull request using `Add {PROJECT} in {LANGUAGE}` format
- [ ] I added a `testinfo.yml` files (see [contributing documentation][contributing-new-language])
- [ ] I used an officially supported docker image or one that I personally trust
- [ ] I created/updated the language README (see [contributing documentation][contributing-readme])
- [ ] I added the sample program name to the README
- [ ] I added fun facts (i.e. debut developer, typing, etc.)
- [ ] I added reference link(s) to the README
- [ ] I added solution citations when necessary (see [plagiarism][contributing-plagiarism])


## I Am Adding New Tests for a Project

- [ ] I fixed #your-issue-number-here
- [ ] I named the pull request using `Add {PROJECT} tests` format
- [ ] I verified the project exists on the [Sample Programs Project List][sample-programs-project-list]
- [ ] I added tests for every test case in the Testing table of the project description for the given project. (See [contributing documentation][contributing-tests-in-detail])


## I Am Modifying an Existing Code Snippet or Existing Tests

- [ ] I fixed #your-issue-number-here
- [ ] I have read about modifying existing code snippets or tests in the [contributing documentation][contributing-modifications]
- [ ] I have explained why this modification is _necessary_ either in the issue linked above or in the notes below
- [ ] I named the pull request using `Modify {PROJECT} {tests} in {LANGUAGE}` format


## Other Notes

Add notes here...



[renegade-coder]: https://therenegadecoder.com/
[contributing-plagiarism]: https://github.com/TheRenegadeCoder/sample-programs/blob/master/.github/CONTRIBUTING.md#plagiarism
[contributing-new-project]: https://github.com/TheRenegadeCoder/sample-programs/blob/contributing/.github/CONTRIBUTING.md#requirements-for-a-new-project
[contributing-readme]: https://github.com/TheRenegadeCoder/sample-programs/blob/contributing/.github/CONTRIBUTING.md#create-readmes
[contributing-tests-in-detail]: https://github.com/TheRenegadeCoder/sample-programs/blob/contributing/.github/CONTRIBUTING.md#tests-in-detail
[contributing]: ../CONTRIBUTING.md
[sample-programs-project-list]: https://sample-programs.therenegadecoder.com/projects/
[contributing-modifications]: https://github.com/TheRenegadeCoder/sample-programs/blob/contributing/.github/CONTRIBUTING.md#modifying-existing-code-snippets
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/new-project-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Please fill out the following sections.
For more information please refer to our [contributing documentation][contributing]

- [ ] I fixed #your-issue-number-here
- [ ] I named the pull request using `Add {PROJECT}` format
- [ ] I named the pull request using `Add {PROJECT} tests` format
- [ ] I verified the project exists on the [Sample Programs Project List][sample-programs-project-list]
- [ ] I added tests for every test case in the Testing table of the project description for the given project. (See [contributing documentation][contributing-tests-in-detail])

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/refactor.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For more information please refer to our [contributing documentation][contributi
- [ ] I fixed #your-issue-number-here
- [ ] I have read about modifying existing code snippets or tests in the [contributing documentation][contributing-modifications]
- [ ] I have explained why this modification is _necessary_ either in the issue linked above or in the notes below
- [ ] I named the pull request using `Modify {PROJECT} {TESTS} in {LANGUAGE}` format
- [ ] I named the pull request using `Modify {PROJECT} {tests} in {LANGUAGE}` format

## Notes

Expand Down

0 comments on commit 22de3d0

Please sign in to comment.