Skip to content

Commit

Permalink
Add Template Additions and Modifications to Repo (#4093)
Browse files Browse the repository at this point in the history
  • Loading branch information
TiaMarieG authored Feb 5, 2025
1 parent bf10fae commit f015137
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Documentation
about: Request to add or modify text within the repository
title: Fix Documentation for {DOCUMENT NAME}
labels: enhancement
assignees: ''
---

To request modifying documentation within the repository, please fill out the following:

Broken Link: Indicate what link or links are broken

Other: Indicate what needs to be added or changed

> Please provide more detailed information in the Other Notes section such as what happens when the broken links are clicked on or why you feel the 'Other' changes should be implemented
## Other Notes

Add notes here...



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 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
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 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])
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 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
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 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
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

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

0 comments on commit f015137

Please sign in to comment.