Skip to content

add PR template for new SPECs #393

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

Merged
merged 6 commits into from
Jul 25, 2025
+32 −0
Merged

add PR template for new SPECs #393

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5c7856e
add PR template
drammock May 22, 2025
4f59218
try the fancy way
drammock Jun 9, 2025
19e8a44
Update .github/pull_request_template.md
jarrodmillman Jul 18, 2025
fc08a13
remove section about "public comments" thread
drammock Jul 24, 2025
2c8b012
Merge branch 'main' into pr-template
stefanv Jul 25, 2025
fb22492
Add missing full stop
stefanv Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/new_spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!-- Thanks for proposing a new SPEC! Make sure your PR title is descriptive and short. -->

## Attestation

- [ ] I have read and understood the [SPEC Purpose and Process](https://scientific-python.org/specs/purpose-and-process/) guidelines

## Description

<!--- Please summarize the purpose of this new SPEC, in 1-3 sentences. -->

## Link to SPEC Committee's "viability" discussion thread (required)

<!--
Insert a link to this proposal's initial viability discussion thread in
https://discuss.scientific-python.org/c/specs/ideas
-->

## Link to "public comments" discussion thread (required)

<!--
insert a link to this proposal's community-wide discussion thread in
https://discuss.scientific-python.org/c/specs/web-comments
-->
Copy link
Member

@stefanv stefanv Jul 21, 2025

Choose a reason for hiding this comment

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

This only appears once the SPEC PR has been merged.

Suggested change
## Link to "public comments" discussion thread (required)
<!--
insert a link to this proposal's community-wide discussion thread in
https://discuss.scientific-python.org/c/specs/web-comments
-->

Copy link
Member

@bsipocz bsipocz Jul 21, 2025

Choose a reason for hiding this comment

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

while the link is incorrect, isn't the assumption here is that there is already a discourse thread about a SPEC topic prior opening a PR with the SPEC text?

Copy link
Member

@stefanv stefanv Jul 22, 2025

Choose a reason for hiding this comment

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

We haven't had a requirement for public comments on the forum; public comments come in on the GH PR, typically.

Copy link
Member

@stefanv stefanv Jul 22, 2025

Choose a reason for hiding this comment

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

(And, once published, they can comment on the SPEC itself directly from the website.)


## Description of (or link to) exploratory discussions/POCs (optional)

<!--
SPEC guidelines suggest a first step of one of the following:

1. discuss the idea with at least one project in the ecosystem,
1. discuss the idea with at least one other member of the ecosystem, or
1. create a minimal, proof of concept (POC) prototype.

(see https://scientific-python.org/specs/purpose-and-process/#new-spec-proposals).
In this field, include a description of those preliminary steps and/or links to public discussions or POCs.
-->
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
If you are opening this PR to propose a new SPEC, please go to the `Preview` tab,
then [click here for the new SPEC template](?expand=1&template=new_spec.md).
Otherwise, delete this text and proceed with your PR as normal.