Add Template Additions and Modifications to Repo #4093
Conversation
…gitignore. Updated PULL_REQUEST to reflect a checkbox for removing added packages
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
|
https://github.com/TiaMarieG/sample-programs - Here is the fork that I've been working on. |
|
@TiaMarieG I think you'll need to enable Issues in your fork. Alternatively, you could just create a new repo with the Issues and PR templates |
.github/ISSUE_TEMPLATE.md
Outdated
There was a problem hiding this comment.
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.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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.
|
@rzuckerm I went ahead and enabled issues in my fork. I'm still learning the in's and out's of GitHub, so I wasn't aware of this feature! |
…to be less confusing for users
|
@TiaMarieG I'm not seeing the new issue template. The existing one look the same as we already have. I haven't tried the PR template yet. However, from what I can tell the PR template looks file, |
|
I just renamed the new issue template to contribute-to-repo and placed it under ISSUE_TEMPLATE. Let me know if you still can't see it. There might be an issue with my codespace. |
|
@TiaMarieG The new issues template is not showing up. Please take a look at the other issues templates. I believe they have to be named a certain way and have YAML at the top that indicate the name of the button as well as other attributes. See this for details. If I'm interpreting the original issue, this is geared to fixing documentation, so it should be named accordingly. |
|
@TiaMarieG Any plans to continue this work? If not, please close this PR and associated issue |
|
Apologies, yes, I will continue to work on it in the coming days. |
|
Ok, I added a YAML to the top. Let me know if it still isn't visible. If not, I may just drop this particular issue and see if it can be incorporated into the pull request template instead. |
There was a problem hiding this comment.
Actually, after re-reviewing this, I have some comments:
- This is about documentation, not contributing to the repo, so the title should be
Fix Documentation for {DOCUMENT NAME}, and the filename should bedocumentation.md - This is an issue, not a pull request, so the text should be geared toward indicating what the problem is with the documentation. For example:
[ ] Broken Link - indicate what link or links are broken in the Other Notes section [ ] Other - indicate what needs to be added or changed in the Other Notes section
|
Alright, I made the requested changes and I adjusted the document to more closely resemble how the others look. |
Congrats on taking the first step to contributing to the Sample Programs repository maintained by The 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
Other Notes
Made minor contributions to PULL_TEMPLATE
Created a new template for repo contribution
Added node_modules/ to .gitignore