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 13 commits into
base: main
Choose a base branch
from

Conversation

TiaMarieG
Copy link
Contributor

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

@github-advanced-security
Copy link

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.

Copy link
Collaborator

@rzuckerm rzuckerm left a comment

Choose a reason for hiding this comment

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

Do you have a repo where I can see what this looks like?

@@ -1,4 +1,4 @@

Copy link
Collaborator

Choose a reason for hiding this comment

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

This is already in there. See the Node.js comment in this file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apologies. I did a pull earlier and my program stated that it was up-to-date. I just did another and it is now reflecting the Node.js comment.

@rzuckerm rzuckerm requested a review from jrg94 December 20, 2024 21:46
@TiaMarieG
Copy link
Contributor Author

https://github.com/TiaMarieG/sample-programs - Here is the fork that I've been working on.

@rzuckerm
Copy link
Collaborator

@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

Copy link
Member

@jrg94 jrg94 left a comment

Choose a reason for hiding this comment

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

Really nice work! I think a couple tweaks will get us there.

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.

@@ -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.

@TiaMarieG
Copy link
Contributor Author

@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!

@rzuckerm
Copy link
Collaborator

rzuckerm commented Dec 21, 2024

@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,

@TiaMarieG
Copy link
Contributor Author

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.

@rzuckerm
Copy link
Collaborator

rzuckerm commented Dec 21, 2024

@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.

@rzuckerm rzuckerm added the enhancement Any code that improves the repo label Dec 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Any code that improves the repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Contribute to PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE
3 participants