Skip to content

Commit e9a498f

Browse files
Grammar and formatting fixes to the MAINTENANCE document
1 parent b4a02d0 commit e9a498f

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

MAINTENANCE.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# Issue Supervisor Role
2-
This document formally defines the _Issue Supervisor_ role. This is a repository maintenance role that is assigned to core contributors on rotating basis.
2+
3+
This document formally defines the _Issue Supervisor_ role. This is a repository maintenance role that is assigned to core contributors on a rotating basis.
34

45
## Responsibilities
5-
Issue supervisor is responsible for:
6-
- Health of the CI, nightly releases and benchmark infrastructure.
6+
7+
The issue supervisor is responsible for:
8+
9+
- The health of the CI, nightly releases and benchmark infrastructure.
710
- PRs of external contributors: assigning someone to review, or handling themselves.
811
- Triaging issues (especially new):
912
- Each issue needs to be assigned an `itype` and 1 or more `area` labels.
@@ -16,29 +19,34 @@ Issue supervisor is responsible for:
1619
Other core teammates are responsible for providing information to the issue supervisor in a timely manner when it is requested if they have that information.
1720

1821
## Assignment
19-
Issue supervisor is appointed for 7 days and is responsible for what is specified in the “Responsibilities” section during those 7 days. Their assumption of the role starts from the Dotty Meeting on Monday and ends on the next Dotty Meeting on Monday.
22+
23+
The issue supervisor is appointed for 7 days and is responsible for what is specified in the “Responsibilities” section during those 7 days. Their assumption of the role starts from the Dotty Meeting on Monday and ends on the next Dotty Meeting on Monday.
2024

2125
During the Dotty Meeting, an issue supervisor is assigned for the current week and for the week after that.
2226

23-
Issue supervisor schedule is maintained in the [Issue Supervisor Statistics spreadsheet](https://docs.google.com/spreadsheets/d/19IAqNzHfJ9rsii3EsjIGwPz5BLTFJs_byGM3FprmX3E/edit?usp=sharing). So, someone who knows their availability several weeks ahead into the future can assign themselves to be an issue supervisor well ahead of time.
27+
The issue supervisor schedule is maintained in the [Issue Supervisor Statistics spreadsheet](https://docs.google.com/spreadsheets/d/19IAqNzHfJ9rsii3EsjIGwPz5BLTFJs_byGM3FprmX3E/edit?usp=sharing). So, someone who knows their availability several weeks ahead into the future can assign themselves to be an issue supervisor well ahead of time.
2428

2529
## Prerequisites
30+
2631
An issue supervisor needs to have all the accesses and privileges required to get their job done. This might include:
32+
2733
- Admin rights in lampepfl/dotty repository
2834
- Admin rights in lampepfl/dotty-feature-requests repository
29-
- Permissions to create new repositories in lampepfl organization (needed to fork repositories for the community build)
35+
- Permission to create new repositories in lampepfl organization (needed to fork repositories for the community build)
3036
- Access to the LAMP slack to be able to ask for help with the infrastructure, triaging and such
3137

3238
## Procedures
33-
To ensure proper health of the infrastructure, the supervisor regularly monitors its proper operation. If a malfunction is detected, the supervisor's job is to ensure that someone is working on it (or solve it on their own).
39+
40+
To ensure the proper health of the infrastructure, the supervisor regularly monitors its proper operation. If a malfunction is detected, the supervisor's job is to ensure that someone is working on it (or solve it on their own).
3441

3542
If it is unclear what area an issue belongs to, the supervisor asks for advice from other team members on Slack or GitHub. If, after asking for advice, it turns out that nobody in the team knows how to classify it, the issue must be classified with a “stat:needs triage” label.
3643

3744
If it is unclear who should review an external PR, the supervisor asks for advice from the rest of the core team. If after asking for advice, it is still unclear who should do it, the reviewer for such a PR will be decided at the next Dotty meeting.
3845

39-
In general, if anything else is unclear for proper fulfillment of responsibilities, the supervisor must proactively seek advice from other team members on Slack or other channels.
46+
In general, if anything else is unclear for the proper fulfillment of responsibilities, the supervisor must proactively seek advice from other team members on Slack or other channels.
4047

4148
## Reporting
49+
4250
At the end of their supervision period, the supervisor reports to the team during the Dotty meeting on the following points:
4351

4452
- Whether there were any incidents with the CI, nightlies and benchmarks, how they were resolved and what steps were taken to prevent them from happening in the future.
@@ -47,7 +55,8 @@ At the end of their supervision period, the supervisor reports to the team durin
4755
- If new labels were created or old ones were removed, or there is any other feedback on how to improve the issue supervision, mention that.
4856
- Unassigned PRs and issues that the team failed to classify: bring them one by one so that the team can make a decision on them.
4957

50-
# Maintenance List
58+
## Maintenance List
59+
5160
The following is the list of all the principal areas of the compiler and the core team members who are responsible for their maintenance:
5261

5362
- Parser: @odersky
@@ -73,5 +82,5 @@ The following is the list of all the principal areas of the compiler and the cor
7382
- Vulpix: @dwijnand, @prolativ
7483
- JVM backend: @Kordyjan, (@sjrd)
7584
- Derivation & Mirrors: @bishabosha, (@dwijnand)
76-
- Linting (especially unused warnings) / Reporting UX : VirtusLab TBD?
85+
- Linting (especially unused warnings) / Reporting UX: VirtusLab TBD?
7786
- Java-compat: @Kordyjan

0 commit comments

Comments
 (0)