diff --git a/.github/ISSUE_TEMPLATE/contribute-to-repo.md b/.github/ISSUE_TEMPLATE/contribute-to-repo.md new file mode 100644 index 000000000..caa229e19 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/contribute-to-repo.md @@ -0,0 +1,35 @@ +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] + +## There is a broken link I want to report + +- [ ] I fixed #your-issue-number-here +- [ ] I named the pull request using `Fixed {BROKEN LINK} in {DOCUMENTATION NAME}` format + + +## I want to contribute to the repo in another way + +- [ ] I fixed #your-issue-number-here +- [ ] I ensured that there are no typos and contribution is grammatically correct +- [ ] I named the pull request using `Add {CONTRIBUTION} to {DOCUMENTATION NAME}` 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/master/.github/CONTRIBUTING.md#requirements-for-a-new-project +[contributing-new-language]: https://github.com/TheRenegadeCoder/sample-programs/blob/master/.github/CONTRIBUTING.md#requirements-for-a-new-language +[contributing-readme]: https://github.com/TheRenegadeCoder/sample-programs/blob/master/.github/CONTRIBUTING.md#create-readmes +[contributing-tests-in-detail]: https://github.com/TheRenegadeCoder/sample-programs/blob/master/.github/CONTRIBUTING.md#tests-in-detail +[contributing]: ../CONTRIBUTING.md +[sample-programs-project-list]: https://sampleprograms.io/projects/ +[contributing-modifications]: https://github.com/TheRenegadeCoder/sample-programs/blob/master/.github/CONTRIBUTING.md#modifying-existing-code-snippets \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 96ec50f32..aadde4367 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,12 +9,14 @@ For more information please refer to our [contributing documentation][contributi ## I Am Adding a New Code Snippet in an Existing Language - [ ] I fixed #your-issue-number-here +- [ ] I did not include any extra folders/libraries - [ ] I named the pull request using `Add {PROJECT} in {LANGUAGE}` format ## I Am Adding a New Code Snippet in a New Language - [ ] I fixed #your-issue-number-here +- [ ] I did not include any extra folders/libraries - [ ] 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 @@ -23,6 +25,7 @@ For more information please refer to our [contributing documentation][contributi ## I Am Adding New Tests for a Project - [ ] I fixed #your-issue-number-here +- [ ] I did not include any extra folders/libraries - [ ] 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]) @@ -31,6 +34,7 @@ For more information please refer to our [contributing documentation][contributi ## I Am Adding New Tests for a Language - [ ] I fixed #your-issue-number-here +- [ ] I did not include any extra folders/libraries - [ ] I named the pull request using `Add {LANGUAGE} Tests` 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 @@ -40,6 +44,7 @@ For more information please refer to our [contributing documentation][contributi ## I Am Modifying an Existing Code Snippet or Existing Tests - [ ] I fixed #your-issue-number-here +- [ ] I did not include any extra folders/libraries - [ ] 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 diff --git a/.gitignore b/.gitignore index 6b8c5c5db..bf4721caf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ - .idea/ *.class *.java~