Create PR template for ondemand#5442
Conversation
Add a pull request template for contributors.
Bubballoo3
left a comment
There was a problem hiding this comment.
I think this looks OK but we might want something a little more streamlined since we are doing PRs here more often than ood_core. I think there is a balance we can strike where we communicate the relevant info to external contributors without adding a lot of overhead to everyday maintenance. That's just my impression though, we could always adjust it later if it actually does cause a headache
| A brief description of the change and why it's being made. | ||
|
|
||
| ## Related issue | ||
| Closes #___ *(if applicable)* |
There was a problem hiding this comment.
| Closes #___ *(if applicable)* | |
| Fixes #___ *(if applicable)* |
This is the language that our automation looks for
|
|
||
| ## Checklist | ||
| - [ ] Follows project code style and conventions | ||
| - [ ] Documentation updated *(if new feature or behavior change)* |
There was a problem hiding this comment.
This applied to ood_core since it has inline documentation, but the workflow for ondemand is to resolve documentation after merging. (see #5348 and OSC/ood-documentation#1349) for a recent example of this. So I'd say just remove this line and we will mention docs in the review process if needed.
| > Please review our [Contributing Guide](https://github.com/OSC/ondemand/blob/master/CONTRIBUTING.md) before submitting a pull request. | ||
|
|
||
| ## What does this PR do? | ||
| A brief description of the change and why it's being made. |
There was a problem hiding this comment.
Let's place this section below the 'Related issue' section to stay closer to the conventions that we typically use (where a pr starts with 'Fixes XXXX. Makes changes...')
We need to add instructions specifically for AI - in a commented field above. Myself, I'd go hard and just have it not open the pull request at all or announce yourself as a bot and that this is all ai slop, but I'll defer to others. In any case I would say it has to announce itself as a bot at the very least. |
Add a pull request template for contributors. same as ood_core. nothing has changed