|
| 1 | +Congrats on taking the first step to contributing to the Sample Programs repository maintained by [The Renegade Coder][renegade-coder]! |
| 2 | +For simplicity, please make sure that your pull request includes one and only one contribution. |
| 3 | + |
| 4 | +Please fill _one_ of the sections below as applicable. |
| 5 | +Please also add any other relevant information to the Notes section at the bottom. |
| 6 | +You may delete or just ignore any other sections. |
| 7 | +For more information please refer to our [contributing documentation][contributing] |
| 8 | + |
| 9 | +## I Am Adding a New Code Snippet in an Existing Language |
| 10 | + |
| 11 | +- [ ] I fixed #your-issue-number-here |
| 12 | +- [ ] I named the pull request using `Add {PROJECT} in {LANGUAGE}` format |
| 13 | +- [ ] I created/updated the language README (see [contributing documentation][contributing-readme]) |
| 14 | + - [ ] I added the sample program name to the README |
| 15 | + - [ ] I added fun facts (i.e. debut developer, typing, etc.) |
| 16 | + - [ ] I added reference link(s) to the README |
| 17 | + - [ ] I added solution citations when necessary (see [plagiarism][contributing-plagiarism]) |
| 18 | + |
| 19 | + |
| 20 | +## I Am Adding a New Code Snippet in a New Language |
| 21 | + |
| 22 | +- [ ] I fixed #your-issue-number-here |
| 23 | +- [ ] I named the pull request using `Add {PROJECT} in {LANGUAGE}` format |
| 24 | +- [ ] I added a `testinfo.yml` files (see [contributing documentation][contributing-new-language]) |
| 25 | + - [ ] I used an officially supported docker image or one that I personally trust |
| 26 | +- [ ] I created/updated the language README (see [contributing documentation][contributing-readme]) |
| 27 | + - [ ] I added the sample program name to the README |
| 28 | + - [ ] I added fun facts (i.e. debut developer, typing, etc.) |
| 29 | + - [ ] I added reference link(s) to the README |
| 30 | + - [ ] I added solution citations when necessary (see [plagiarism][contributing-plagiarism]) |
| 31 | + |
| 32 | + |
| 33 | +## I Am Adding New Tests for a Project |
| 34 | + |
| 35 | +- [ ] I fixed #your-issue-number-here |
| 36 | +- [ ] I named the pull request using `Add {PROJECT} tests` format |
| 37 | +- [ ] I verified the project exists on the [Sample Programs Project List][sample-programs-project-list] |
| 38 | +- [ ] 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]) |
| 39 | + |
| 40 | + |
| 41 | +## I Am Modifying an Existing Code Snippet or Existing Tests |
| 42 | + |
| 43 | +- [ ] I fixed #your-issue-number-here |
| 44 | +- [ ] I have read about modifying existing code snippets or tests in the [contributing documentation][contributing-modifications] |
| 45 | +- [ ] I have explained why this modification is _necessary_ either in the issue linked above or in the notes below |
| 46 | +- [ ] I named the pull request using `Modify {PROJECT} {tests} in {LANGUAGE}` format |
| 47 | + |
| 48 | + |
| 49 | +## Other Notes |
| 50 | + |
| 51 | +Add notes here... |
| 52 | + |
| 53 | + |
| 54 | + |
| 55 | +[renegade-coder]: https://therenegadecoder.com/ |
| 56 | +[contributing-plagiarism]: https://github.com/TheRenegadeCoder/sample-programs/blob/master/.github/CONTRIBUTING.md#plagiarism |
| 57 | +[contributing-new-project]: https://github.com/TheRenegadeCoder/sample-programs/blob/contributing/.github/CONTRIBUTING.md#requirements-for-a-new-project |
| 58 | +[contributing-readme]: https://github.com/TheRenegadeCoder/sample-programs/blob/contributing/.github/CONTRIBUTING.md#create-readmes |
| 59 | +[contributing-tests-in-detail]: https://github.com/TheRenegadeCoder/sample-programs/blob/contributing/.github/CONTRIBUTING.md#tests-in-detail |
| 60 | +[contributing]: ../CONTRIBUTING.md |
| 61 | +[sample-programs-project-list]: https://sample-programs.therenegadecoder.com/projects/ |
| 62 | +[contributing-modifications]: https://github.com/TheRenegadeCoder/sample-programs/blob/contributing/.github/CONTRIBUTING.md#modifying-existing-code-snippets |
0 commit comments