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.

Sign up for GitHub

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

Jump to bottom

Contribute to PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE #4015

Open
TiaMarieG opened this issue Nov 11, 2024 · 5 comments · May be fixed by #4093
Open

Contribute to PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE #4015

TiaMarieG opened this issue Nov 11, 2024 · 5 comments · May be fixed by #4093
Assignees
@TiaMarieG
Labels
enhancement Any code that improves the repo

Comments

@TiaMarieG
Copy link
Contributor

I'd like to contribute to the PULL_REQUEST_TEMPLATE.md. The first 'contributing documentation' link is broken and presents a 404 error when clicked on. I also want to add a checkbox under the first category 'Adding a New Code Snippet in an Existing Language' where people have to check that they've removed excess packages they may have installed while working on their code segment (For example: I added node_modules and json files when working on mine and didn't remove them before committing). This would cut down on the maintainers having to remind people to do so.

Also, since there is no option to submit an issue for .md sections under .github, I'd like to make an ISSUE_TEMPLATE for people to use to report broken links or list their contributions they'd like to make to the repo information.
@rzuckerm
Copy link
Collaborator

I fixed the 'contributing document' link. I'll have to discuss the rest of this with @jrg94 since this is his repository.

@jrg94
Copy link
Member

jrg94 commented Nov 12, 2024

I'm fine with the pull request template changes, but I might also recommend being more proactive with our .gitignore. In the example, we could easily ignore node modules. I suspect there are other file formats or directories we could reliably ignore. Ultimately, I don't mind covering our tracks in both places (i.e., the gitignore and having a checkbox). Historically, I do worry that the current pull request template overwhelms folks. I wish GitHub had a way of using multiple pull request templates. Perhaps we can adopt a model more akin to the ones described in this thread.

As for the issue template, I'm open to having a generic "maintenance" template for fixes. Right now, the three templates are just for additions.

@rzuckerm
Copy link
Collaborator

@TiaMarieG You are assigned.

@rzuckerm
Copy link
Collaborator

@TiaMarieG I would like to ask that you first do a prototype in one of your own repositories to prove that your changes will work here. I do not want to disrupt the current workflow since there is so much activity in this repository.

@TiaMarieG
Copy link
Contributor Author

Today is the final day for my class's participation in the repository, so the activity should die down a little bit, but I'll work on updates in my own fork and submit PR's for feedback.

@jrg94 jrg94 added the enhancement Any code that improves the repo label Nov 15, 2024
@TiaMarieG TiaMarieG linked a pull request Dec 20, 2024 that will close this issue
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TiaMarieG TiaMarieG

Labels
enhancement Any code that improves the repo
Projects
Documentation
Status: To do
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Template Additions and Modifications to Repo TiaMarieG/sample-programs
3 participants
@rzuckerm @jrg94 @TiaMarieG