Skip to content

Commit 112459a

Browse files
authored
[ci skip] updating MESA Developers documentation (#475)
1 parent 54acecf commit 112459a

File tree

4 files changed

+31
-52
lines changed

4 files changed

+31
-52
lines changed

docs/source/about.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ The missions of the MESA Team are:
9696
facilitating and encouraging appropriate scientific collaborative
9797

9898

99-
1st Author
100-
----------
99+
1st Author Emeritus
100+
-------------------
101101

102102
* `Bill Paxton <https://www.kitp.ucsb.edu/paxton>`__
103103

@@ -112,7 +112,6 @@ Developers
112112
* Aaron Dotter
113113
* `Robert Farmer <http://rjfarmer.io/>`__
114114
* Eoin Farrell
115-
* `Adam Jermyn <http://adamjermyn.com/>`__
116115
* `Meridith Joyce <http://www.meridithjoyce.com/>`__
117116
* Pablo Marchant
118117
* `Radek Smolec <https://www.camk.edu.pl/en/staff/smolec/>`__
@@ -126,6 +125,7 @@ Past Developers
126125

127126
* `Ed Brown <http://web.pa.msu.edu/people/ebrown/>`__
128127
* `Falk Herwig <http://www.astro.uvic.ca/~fherwig/>`__
128+
* `Adam Jermyn <http://adamjermyn.com/>`__
129129
* `Josiah Schwab <https://yoshiyahu.org/>`__ (2013-2021)
130130

131131

docs/source/developing/collaboration.rst

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -82,31 +82,17 @@ is appropriate and documented, and communicating individual developer
8282
contributions to the astrophysics community so that the careers of
8383
developers are enhanced by their engagement.
8484

85+
Currently, the MAC is Lars, Rich, and Frank.
86+
8587
**Onboarding and offboarding processes**
8688

8789
These groups are not static and will change as individuals' engagement
8890
with MESA evolves. If someone is permanently or temporarily unable to
89-
fulfill their responsibilities, they must inform the MAC of the
90-
situation. The MAC will reevaluate the membership of these groups on a
91-
recurring basis. Removal from MD, MTC, and MAC can be for inactivity,
91+
fulfill their responsibilities, they must inform the MD.
92+
Removal from MD, MTC, and MAC can be for inactivity,
9293
harm to the Project, or simply opting out.
9394

94-
Onboarding to MD is done by the MAC in consultation with the MTC and
95-
the MD. When a candidate developer is identified, there will be a
96-
comment period where any MD can privately provide feedback to the MAC
97-
about the addition to the MESA team. Nominations and suggestions from
98-
any MDs are welcome. Currently, the MD are Bill P., Warrick, Evan,
99-
Earl, Lars, Matteo, Aaron, Rob, Adam, Meridith, Pablo, Radek,
100-
Anne, Rich, Bill W, and Frank.
101-
102-
As MESA's "first author", Bill is an ex-officio member of both MAC and
103-
MTC.
104-
105-
Initially, the MTC has members appointed by Bill Paxton. These are
106-
Rich, Pablo, and Rob.
107-
108-
Currently, the MAC is Lars, Rich, and Frank.
109-
95+
Onboarding to the MD is described :doc:`here <developing/new_developers>`.
11096

11197
Instrument Paper Principles
11298
===========================
@@ -118,7 +104,7 @@ Instrument Paper Principles
118104
How do authorship invitations arise?
119105
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
120106

121-
During the completion of the first five MESA Instrument Papers, there have been multiple channels for co-author invitations.
107+
During the completion of the first six MESA Instrument Papers, there have been multiple channels for co-author invitations.
122108

123109
- Running a non-MESA code in a controlled and engaged manner that enables verification of a NEW MESA capability (e.g., Dessart for shocks).
124110

@@ -149,8 +135,3 @@ Prospective co-authors should be prepared to participate by:
149135
The MAC can relax any of these four items when there is value in doing so.
150136

151137

152-
How is it decided who the authors are and their order?
153-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
154-
155-
Final authorship and order is decided by the MAC only near the completion time of the paper.
156-

docs/source/developing/infrastructure.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ ReadTheDocs
5454
-----------
5555

5656
The Sphinx documentation is hosted by `ReadTheDocs
57-
<https://readthedocs.org/>`__. Rich controls the account (and Rob has access to it). This is
57+
<https://readthedocs.org/>`__. Rich controls the account (and Rob and Evan have access to it). This is
5858
currently free for open source software.
5959

6060

@@ -68,11 +68,10 @@ service.
6868
Website
6969
^^^^^^^
7070

71-
We still use the mesa.sourceforge.net website domian name.
72-
The source code for this site lives at https://github.com/MESAHub/mesa-website.
73-
It must be manually updated by someone with SourceForge permissions.
71+
We still use the mesa.sourceforge.net website domian name, but only for a top-level
72+
redirect to docs.mesastar.org.
7473

75-
This site will be made redundant soon and replaced with a redirect to the ReadTheDocs website.
74+
The source code for the old sourceforge site lives at https://github.com/MESAHub/mesa-website.
7675

7776
Slack
7877
-----
@@ -115,6 +114,6 @@ is controlled by Pablo.
115114
Records
116115
^^^^^^^
117116

118-
* The `record for MESA releases <https://zenodo.org/record/4311514>`__ is controlled by Josiah.
117+
* The `record for MESA releases <https://zenodo.org/record/4311514>`__ is controlled by Pablo.
119118
* The `record for OP Mono data <https://zenodo.org/record/4390522>`__ is controlled by Josiah.
120119
* The records for MESA SDK releases (`macOS <https://zenodo.org/record/4638654>`__, `linux <https://zenodo.org/record/4638535>`__) are controlled by Pablo.

docs/source/developing/new_developers.rst

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ New developers
99
What is a developer?
1010
--------------------
1111

12-
A developer is someone who commits to spend (some) time helping to run and maintain the MESA project. This can include adding new code and documentation but also includes many other tasks that are needed to keep the project running. These include (but not limited to) managing and maintaining infrastructure, running meetings, triaging bug reports, merging Pull Requests, applying for funding for infrastructure, and providing technical and scientific knowledge to other developers. The amount of time someone commits is up to the individual to decide on, and it is expected to vary over time as various other tasks take priority.
12+
A developer is someone who commits to spend (some) time helping to run and maintain the MESA project. This can include adding new code and documentation but also includes many other tasks that are needed to keep the project running. These include (but are not limited to) managing and maintaining infrastructure, running meetings, triaging bug reports, merging Pull Requests, applying for funding for infrastructure, and providing technical and scientific knowledge to other developers. The amount of time someone commits is up to the individual to decide on, and it is expected to vary over time as various other tasks take priority.
1313

1414
If you simply want to fix a bug or get some new code added to MESA then you don't need to be a developer. We welcome PR's and bug reports from the community and you don't need to be a developer to contribute that way. Only if you want to take a more active role in managing the MESA project do you need to be a developer.
1515

@@ -33,50 +33,49 @@ Process:
3333
* To veto someone then either:
3434

3535
* Two separate people should raise objections on their own in either slack or mesa-dev.
36-
* Or, one person raises an objection and for privacy reasons they do not want to share this with the entire developer group. In which case they should discuss with another developer, who they trust, and that person can raise the second veto. In this case objections should be communicated to the nominator directly, but the objector does not have to share their reasons.
36+
* Or, one person raises an objection and for privacy reasons they do not want to share this with the entire developer group. In this case, they should discuss with another developer, whom they trust, and that person can raise the second veto. In this case objections should be communicated to the nominator directly, but the objector does not have to share their reasons.
3737

38-
If after the minimum time has elapsed there are insufficient objections then the new developer is approved.
38+
If after the minimum time has elapsed there are insufficient objections, then the new developer is approved.
3939

4040
.. note::
4141
With this process we are attempting to balance having a flexible procedure for bringing in new developers while providing an environment that all developers can work safely in. There may be reasons why someone does not want to share the reasons for vetoing someone. However we also want to balance the possibility for abuse of the system by allowing arbitrary vetoes, which may preclude people from certain groups. We are adopting this process through the calendar year 2023, and plan to evaluate and vote on whether to make it permanent at the beginning of 2024.
4242

43-
Post acceptance
43+
Post Acceptance
4444
---------------
4545

46-
Assuming the new developer has been accepted then the nominator:
46+
Assuming the new developer has been accepted, the nominator:
4747

4848
* Makes sure the new developer agrees to the code of conduct and knows that discussions on dev channels should be considered private and may include work in progress and thus should not be shared.
49-
* Makes sure the new developer gets access to the infrastructure (github, slack, mesa-dev, testhub)
49+
* Makes sure the new developer gets access to the infrastructure (github, slack, mesa-dev, testhub).
5050
* Acts as a mentor to the new developer, helping them to get used to the system and the way things are done. This includes making commits, merging PR's, and general development tasks.
5151

52-
Removing a developer
52+
Removing a Developer
5353
--------------------
5454

5555
At any time an existing developer can retire for any reason if they need to step back from working on MESA.
5656

57-
At times it may be required to forcibly remove an individual from the developer community. This is a serious action and should not be taken lightly. Reasons for this may include (but not limited to) violations of the code of conduct, abuse or harassment of others, or issues of scientific integrity.
57+
At times it may be required to forcibly remove an individual from the developer community. This is a serious action and should not be taken lightly. Reasons for this may include (but are not limited to) violations of the code of conduct, abuse or harassment of others, or issues of scientific integrity.
5858

5959
In the event that a developer needs to be removed, then an existing developer should call a vote to remove the person. This vote should be seconded by another developer. Removal then requires a majority of existing developers to vote for removal. If the developer is removed then commit access to MESA will be removed, as well as the developer's access to the MESA developers communication channels (slack, mesa-dev).
6060

6161
In exceptional time-sensitive circumstances the administrators of the MESA infrastructure (mailing lists, github, slack, testhub) may suspend a developer's access if they feel that waiting for a vote would not be appropriate. Reasons can include (but are not limited to): posting abusive messages, denial or degradation of service, committing malicious code, or other actions that the admin feels is damaging the infrastructure. This is not a removal from being a developer, but should be considered a serious issue. The admin should discuss their reasons at the earliest opportunity with the other developers, and this must lead either to a vote to remove the developer or a clear path toward ending the suspension.
6262

63-
Approving this document
63+
Approving This Document
6464
-----------------------
6565

66-
As we do not currently have a process for approving documents of this nature we need to bootstrap this process.
66+
This document was approved by unanimous consent of the current MESA Developers as of December 2022.
6767

68-
Once the document has been iterated on it will be put to a vote of all current developers. Hopefully we can iterate this such that everyone is happy before we put this document to a vote. If someone has serious concerns then please raise them before the vote.
69-
Acceptance will require unanimous consent.
70-
Abstentions will count as implicit approval. Thus only a direct no vote will count against it.
71-
The vote will be held on slack (and emailed to mesa-dev) with an appropriate period of time for people to read and approve this document.
72-
73-
Changing this document
68+
Changing This Document
7469
----------------------
7570

76-
Once approved changes to this document will follow the same process as the initial approval process.
71+
Changes to this document will follow the same process as the initial approval process.
7772

73+
Changes will be put to a vote of all current developers. If someone has serious concerns then please raise them before the vote.
74+
Acceptance will require unanimous consent.
75+
Abstentions will count as implicit approval. Thus only a direct no vote will count against it.
76+
The vote will be held on slack (and emailed to mesa-dev) with an appropriate period of time for people to read and approve this document.
7877

7978
Changelog
8079
---------
8180

82-
* Initial document approved 5th december 2022
81+
* Initial document approved December 5, 2022

0 commit comments

Comments
 (0)