A new draft pull request template#4306
Conversation
|
Very good initiative! I think using the same license as M2 should be encouraged. |
|
|
||
| Provide a clear and concise summary of your changes here. | ||
|
|
||
| ## AI Use |
There was a problem hiding this comment.
Two things:
- maybe "AI Attribution" or "AI Disclosure" instead?
- I lean towards something more direct, kinda like the License section, but maybe that's just me.
|
This looks great, but to make small PRs easier to handle, you might want to have at the beginning an option like |
…le pull request templates
[skip ci]
|
So I have been playing around what these pull request templates look like in practice on my fork: https://github.com/jkyang92/M2. (To make them work I pushed to the stable branch of my fork, so the commits are a bit messy) The multiple issues templates workflow seems quite slick, but they don't currently support the same workflow for pull requests, so there's a bit of a hack in the default pull request to allow multiple different templates. Feel free to try submitting issues or pull requests to try them out. The issue templates are the defaults that Github can setup for you, and have not been further reviewed. |
|
The issue templates are nice on some repos, but do they solve a problem for us? |
Description
Closes: None
This is a very rough draft of a pull request template. I've also modeled it slightly here in this pull request. This is based in part on the post on Zulip by @sonjapetrovic, but doesn't replicate it exactly. (See: https://macaulay2.zulipchat.com/#narrow/channel/597423-Workshop.3A-2026-Atlanta/topic/Info.20for.20Draft.20M2.20AI.20Usage.20Policy.20and.20a.20PR.20template/near/595095740) It is also based in part on the discussions from on AI policy at the "The Future of Macaulay2" workshop.
The idea for this is to have a draft so that we can discuss, and should not be viewed as a final proposal in any way.
We should also have a draft issue template, but we can focus on one at a time.
AI Use
Please declare your use of AI on this pull request
Extent of AI Usage: None
AI Details:
Model(s) Used: N/A
AI Involvement Level:
How was AI used? N/A
License
Choose one of the following