Skip to content
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

Add Template Additions and Modifications to Repo #4093

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This more closely mirrors our existing pull request template, in which case I think it’s fine to move the additional headings into that template. If this is meant to be the new issue template, I think it needs to go into the ISSUE_TEMPLATES folder.

Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 removed imported frameworks/libraries/packages or added them to .gitignore
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably write this as “I did not include any extra folders or libraries” or something similar. I think remove might confuse some folks into thinking they need to remove something.

- [ ] 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 removed imported frameworks/libraries/packages or added them to .gitignore
- [ ] 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
Expand All @@ -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 removed imported frameworks/libraries/packages or added them to .gitignore
- [ ] 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 All @@ -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 removed imported frameworks/libraries/packages or added them to .gitignore
- [ ] 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
Expand All @@ -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 removed imported frameworks/libraries/packages or added them to .gitignore
- [ ] 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
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

node_modules/
.idea/
*.class
*.java~
Expand Down
Loading