Skip to content

Clarify the SPEC process: scope, procedure #395

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

Merged
merged 12 commits into from
Aug 5, 2025

Conversation

stefanv
Copy link
Member

@stefanv stefanv commented Jun 5, 2025

This PR aims to clarify the SPEC process to make it very clear to new contributors what the procedures are for submitting a SPEC, as well is what is, and is not, in scope for a SPEC.

/cc @scientific-python/spec-steering-committee

@stefanv stefanv requested a review from jarrodmillman June 5, 2025 21:29
Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

Thanks, these feels like great improvements. I have some minor comments.

@bsipocz bsipocz added the documentation Improvements or additions to documentation label Jun 5, 2025
Co-authored-by: Brigitta Sipőcz <[email protected]>
Copy link
Member

@ivanov ivanov left a comment

Choose a reason for hiding this comment

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

This indeed reads better, thank you!

@jarrodmillman
Copy link
Member

Thanks!! I am on vacation until Monday, so I just took a quick scan. I will do a more careful review then. It would be worth trying to get as many steering committee members approving this as possible. Just to make sure we are all on the same page.

You may want to review

to make sure those sections are in sync with these changes. Also may be worth making sure the information isn't duplicated by linking from here to this page or vice versa.

@jarrodmillman
Copy link
Member

jarrodmillman commented Jun 6, 2025

You may also want to make a PR template and update the quickstart script to make sure people are looking at (and following) the process information.

Probably best to work with #393 and update the quickstart script to address the limitations of the PR template.

Copy link
Contributor

@lucascolley lucascolley left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@tupui tupui left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

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

Overall LGTM. Thanks!

Question: This document does not say what happens if a SPEC proposal is rejected; did I miss it elsewhere?

There is also issue with the flowchart in dark mode but I will open separate issue for that (#396) as dark mode is out of scope here.

@stefanv
Copy link
Member Author

stefanv commented Jul 1, 2025

Also see inline comments from SPEC meeting notes

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

The build failures looks relevant this time, the links don't resolve as expected. Maybe use {ref}`ref-name` syntax instead?

@stefanv stefanv force-pushed the spec-process-clarifications branch from 3ce8288 to 051ad80 Compare July 21, 2025 22:59
@stefanv
Copy link
Member Author

stefanv commented Jul 21, 2025

You may want to review

* https://scientific-python.org/specs/steering-committee/#how-are-specs-accepted

* https://scientific-python.org/specs/steering-committee/#fn:1

to make sure those sections are in sync with these changes. Also may be worth making sure the information isn't duplicated by linking from here to this page or vice versa.

There's still some duplication, but it is now clearly marked.

See 051ad80

@stefanv stefanv force-pushed the spec-process-clarifications branch from 51bd88d to 3b4de89 Compare July 21, 2025 23:07
@stefanv
Copy link
Member Author

stefanv commented Jul 21, 2025

Question: This document does not say what happens if a SPEC proposal is rejected; did I miss it elsewhere?

I don't know if we have anything specific to say on this situation. Two reasons for rejection are:

  1. The idea is not applicable to the wider ecosystem. That could change over time.
  2. There aren't two authors willing to work on the SPEC. Something that can be addressed.

Perhaps the SPEC committee here uses their best judgment.

@stefanv
Copy link
Member Author

stefanv commented Jul 21, 2025

OK, should be ready for another round of review.

@jarrodmillman
Copy link
Member

The build failures looks relevant this time, the links don't resolve as expected. Maybe use {ref}`ref-name` syntax instead?

This looks to be resolved now.

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

Thanks Stefan!

@bsipocz bsipocz merged commit 1102304 into scientific-python:main Aug 5, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants