Skip to content
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

A New Governance Structure: SEP 2 Revision - Final Comment Period #80

Merged
merged 49 commits into from May 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
361d978
Add a revised version of SEP 2.
Cadair Oct 13, 2022
ee1a98e
Apply suggestions from code review
Cadair Oct 14, 2022
b37d170
Spell checking
tiagopereira Oct 16, 2022
48d5a72
Incorporate feedback
Cadair Oct 25, 2022
561f32c
Update SEP-0002-revised.md
Cadair Oct 25, 2022
6edb61f
Update SEP-0002-revised.md
Cadair Oct 26, 2022
af08dfe
More feedback
Cadair Oct 26, 2022
5dc2d06
Rework authority section
Cadair Feb 22, 2023
dd55dbb
Board numbers
Cadair Feb 22, 2023
43b3b58
Steering committee clarifications
Cadair Feb 22, 2023
cb72574
Clarify decision making
Cadair Feb 22, 2023
6377576
Steering Committee clarifications
Cadair Feb 22, 2023
4f1b17a
Update SEP-0002-revised.md
Cadair Feb 22, 2023
e24955c
Project members
Cadair Feb 22, 2023
03197dd
Add a section describing the process for changing this SEP
Cadair Feb 22, 2023
ccfdd90
Some changes by @ehsteve
Cadair Mar 22, 2023
d8664af
Apply suggestions from code review
Cadair Mar 22, 2023
42804ae
Update SEP-0002-revised.md
Cadair Mar 22, 2023
7f79539
Update SEP-0002-revised.md
Cadair Mar 22, 2023
6149c9c
Abstract no more
Cadair Mar 22, 2023
3552683
Captialise things properly
Cadair Mar 22, 2023
fb96506
More comments
Cadair Mar 22, 2023
1a6bccb
Merge remote-tracking branch 'upstream/master' into new_governance
Cadair Mar 22, 2023
e4fc151
Make the pesky linter happy
Cadair Mar 22, 2023
f1fb236
clarify the process for all votes
Cadair Mar 22, 2023
c5533c5
more cleanup
Cadair Mar 22, 2023
c06d814
shut up markdownlint
Cadair Mar 22, 2023
d9c7787
linting is stupid
Cadair Mar 22, 2023
c0d3520
Apply suggestions from code review
Cadair Jun 14, 2023
d6b88cb
s/project member/project custodian/
Cadair Apr 9, 2024
a1d595d
Revise roles on committee
Cadair Apr 9, 2024
7b837e8
Copy editing
Cadair Apr 9, 2024
245bff7
Add list of initial members
Cadair Apr 9, 2024
36d0110
Obudsperson election tweak
Cadair Apr 9, 2024
2517e64
Reorder document as suggested by @ehsteve
Cadair Apr 9, 2024
eee5af7
Merge branch 'master' of github.com:sunpy/sunpy-sep into new_governance
Cadair Apr 9, 2024
048a1b4
typo
Cadair Apr 9, 2024
ddcb3d2
Modify exisiting SEP 2
Cadair Apr 9, 2024
25028c3
Some tweaks during timeline
Cadair Apr 9, 2024
3967725
Address feedback, remove "active Project Custodian"
Cadair Apr 10, 2024
a66e171
Update SEP-0002.md
Cadair Apr 11, 2024
5f147c4
Apply suggestions from code review
Cadair May 7, 2024
0a9f0c5
Suggestions and edits from the board
Cadair May 16, 2024
e2c2828
Add #80 and reformat header table
Cadair May 16, 2024
fc56531
Update SEP-0002.md
Cadair May 16, 2024
7c3c925
Apply suggestions from code review
Cadair May 16, 2024
4989ab0
Remove mentions of the board from the SEP process
Cadair May 16, 2024
761597b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 16, 2024
9048d05
fix typo
Cadair May 16, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .markdownlint.yaml
Expand Up @@ -3,3 +3,6 @@ MD013: false

# Inline HTML
MD033: false

# Duplicate Headings
MD024: false
25 changes: 17 additions & 8 deletions SEP-0001.md
Expand Up @@ -41,28 +41,37 @@ There are generally three types of SEP.

## Creation

SEPs should contain a concise description of a single new idea or proposal. SEPs are generally not necessary for small enhancements through a SEP may sometimes be requested by the SunPy board in some cases even for small changes. A SEP begins its life as a proposal. Legibility, organization, and focus are key features of a successful SEP. SEPs can be rejected out-right if they lack any of those characteristics. All SEPs must identify a champion (usually the author) whose job it is to present and defend the proposal. It is generally a good idea to discuss the new idea with the community and the board before going to the trouble of writing a SEP in order to gauge general opinion however, it is not required. All SEPs will have a SunPy board member assigned to them.
SEPs should contain a concise description of a single new idea or proposal.
SEPs are generally not necessary for small enhancements through a SEP may sometimes be requested by The Steering Committee in some cases even for small changes.
A SEP begins its life as a proposal.
Legibility, organization, and focus are key features of a successful SEP.
SEPs can be rejected out-right if they lack any of those characteristics.
All SEPs must identify a champion (usually the author) whose job it is to present and defend the proposal.
It is generally a good idea to discuss the new idea with the community before going to the trouble of writing a SEP in order to gauge general opinion however, it is not required.

All SEPs creators should begin with the SEP template which is stored as SEP-template.md. All SEPs are stored in the sunpy/sunpy-SEP repository. Fork the repo and create a new file with your SEP. SEP are written with markdown.

### Amending a SEP

If a topic is already covered by an existing SEP and the change is not a major one than it is appropriate to propose an amendment to an existing SEP. All the usual rules apply and processes apply to the amendment of a SEP as for the creation of a new SEP.
If a topic is already covered by an existing SEP and the change is not a major one than it is appropriate to propose an amendment to an existing SEP.
All the usual rules apply and processes apply to the amendment of a SEP as for the creation of a new SEP.

## Submission

All new SEP should be submitted into the sunpy/sunpy-SEP repository by pull request.

## Review Process

Once an SEP is submitted it will be discussed via normal development channels, primarily the sunpy-dev mailing list. The SunPy board is tasked with making the final decision although in general community consensus is enough. Once an SEP is accepted, its implementation can be reviewed through the usual process. Once the implementation is complete and accepted the status of the SEP shall be changed to implemented. A member of the SunPy board may request that a change to SunPy (e.g. Pull Request) requires an SEP to enable the change to be documented, and discussed and reviewed by the community.

New SEPs currently undergoing discussion are pull requests into the sunpy-SEP repository. Discussions about the SEP shall take place primarily using a sunpy mailing list, which should be linked from the SEP. Once a SEP is officially submitted by pull request a SunPy editor must be assigned by the SunPy board. This is generally the job of the SunPy board sponsor but this role can be delegated. The role of the editor is to aid the submitter and make sure that the SEP follows the accepted standard. The author and editor can be the same person. A SEP must be accepted by a majority of the SunPy board. The status of a SEP can be any of the following
Once an SEP is submitted, as a pull request to the sunpy-SEP repository, it will be discussed via normal development channels.
The Steering Committee is tasked with accepting an SEP, this should be done on the basis of agreeing there is commuinity consensus, however, they may act as a tie-break if needed.
The Steering Committee are also responsible for editing SEP drafts and supporting authors of SEPs through the process.
Once an SEP is accepted, its implementation can be reviewed through the usual process.
Once the implementation is complete and accepted the status of the SEP shall be changed to implemented.

* **Discussion**: This means that SEP is currently being considered and a decision has not been made.
* **Accepted**: The SEP has been accepted and it will be assigned a number and merged into the sunpy-SEP repository. A decision rationale must be drafted and added to the SEP by the SunPy board sponsor. If the SEP is of the Standard type then it can now be implemented.
* **Implemented**: Only valid for a Standard SEP. This status means that the feature discussed in the SEP is implemented and has been merged into the main SunPy repository. At least X members of the SunPy board must sign off on implementation for it to be accepted.
* **Rejected**: The SEP has been rejected. A decision rationale should be provided by the board and the SEP should still be assigned a number and merged in order to close the issue. It should be noted that a future SEP can supersede the decision.
* **Accepted**: The SEP has been accepted and it will be assigned a number and merged into the sunpy-SEP repository. A decision rationale must be drafted and added to the SEP by the Steering Committee. If the SEP is of the Standard type then it can now be implemented.
* **Implemented**: Only valid for a Standard SEP. This status means that the feature discussed in the SEP is implemented and has been merged into the main SunPy repository. The Steering Committee must vote to approve an SEP by a simple majority.
* **Rejected**: The SEP has been rejected. A decision rationale should be provided by the Steering Committee and the SEP should still be assigned a number and merged in order to close the issue. It should be noted that a future SEP can supersede the decision.

## SEP Template

Expand Down