Skip to content

A new draft pull request template#4306

Draft
jkyang92 wants to merge 6 commits into
Macaulay2:developmentfrom
jkyang92:pull-request-template
Draft

A new draft pull request template#4306
jkyang92 wants to merge 6 commits into
Macaulay2:developmentfrom
jkyang92:pull-request-template

Conversation

@jkyang92
Copy link
Copy Markdown
Contributor

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

  • I have not used AI
  • I have used AI

Extent of AI Usage: None

AI Details:

Model(s) Used: N/A

AI Involvement Level:

  • Level 2: Superficial (Docstrings, regex, formatting)
  • Level 5: Structural (Algorithm logic, new functions)

How was AI used? N/A

License

Choose one of the following

  • The code in this pull request is the public domain
  • The code in this pull request is licensed under GPLv2+
  • The code in this pull request is licensed under a GPLv2 compatible license (specify below)

@YueRen
Copy link
Copy Markdown
Contributor

YueRen commented May 15, 2026

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
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Two things:

  1. maybe "AI Attribution" or "AI Disclosure" instead?
  2. I lean towards something more direct, kinda like the License section, but maybe that's just me.

@fragandi
Copy link
Copy Markdown
Contributor

This looks great, but to make small PRs easier to handle, you might want to have at the beginning an option like
A. This PR addresses a minor fix: typo, documentation, example (editor contribution). Describe the change in 50 characters or less. No need to read further!
B. This PR address a change in the code (developer contribution). Please, help us review your contribution by providing additional details. The information gathered will not used against you personally but it will help us make an informed decision on whether we can or cannot merge the code in the stable M2 version.

@jkyang92
Copy link
Copy Markdown
Contributor Author

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.

@mahrud
Copy link
Copy Markdown
Member

mahrud commented May 20, 2026

The issue templates are nice on some repos, but do they solve a problem for us?

@d-torrance d-torrance added M2@GT26 Project from the "Future of Macaulay2" workshop at Georgia Tech in May 2026 Infrastructure GitHub workflows, etc. labels May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Infrastructure GitHub workflows, etc. M2@GT26 Project from the "Future of Macaulay2" workshop at Georgia Tech in May 2026

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants