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

Revise PR template #333

Closed
1 task
j08lue opened this issue Nov 6, 2023 · 3 comments
Closed
1 task

Revise PR template #333

j08lue opened this issue Nov 6, 2023 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@j08lue
Copy link
Contributor

j08lue commented Nov 6, 2023

We have a PR template but it most often is not used correctly. Instead, we get PRs without details provided by the user, but just the content of the template:

image

Acceptance criteria

  • Revised PR template
@j08lue j08lue added the enhancement New feature or request label Nov 6, 2023
@stephenkilbourn
Copy link

@j08lue - There is an existing Github action template in the marketplace that enforces that the description has a description that is not the default template. If that default template is unedited like in your screenshot, then the developer would see the message "PR description is too short and seems to not fulfill PR template, please fill in". (that message can be modified from the default)

I could pull in this action and give clarity in the default template so that we see something like:

## Why are you creating this Pull Request?
### Please select one of the following links and follow the provided template

- [Adding Datasets or Stories](?title=Content%3A%20%3Cname%3E&expand=1&template=content.md)
- [Version Release](?title=Deploy%20vX.X.X&expand=1&template=version_release.md)
- [Other](?expand=1&template=default.md)

@j08lue
Copy link
Contributor Author

j08lue commented Nov 28, 2023

That would be much appreciated, @stephenkilbourn, thanks. Same goes for these config repos:

@aboydnw
Copy link
Contributor

aboydnw commented Nov 12, 2024

We revised this PR template with #486

GHGC has their own PR template that they've been iterating on, so we should probably leave that be for now, and eic are not frequent contributors of content. When we add new instances of VEDA we should iterate on this template again to provide those new instances the most useful template

@aboydnw aboydnw closed this as completed Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
3 participants