Skip to content

Commit d17745e

Browse files
authored
Add guide for maintainers to this track.
1 parent 6c1ae65 commit d17745e

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

docs/MAINTAINING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Welcome!
2+
3+
This is a guide/reference for maintainers of the Java track.
4+
5+
- [Your New Permissions](#your-new-permissions)
6+
- [Maintainer Guides](#maintainer-guides)
7+
- [The Project Board](#the-project-board)
8+
- [Miscellaneous](#miscellaneous)
9+
10+
## Your New Permissions
11+
12+
You now have write access to four repositories. "write access" means you can: review, reject, accept and merge PRs; and push changes to these repos. Despite having permissions to push, we tend to see review of even our own PRs.
13+
14+
- [x-common](https://github.com/exercism/x-common) — the library of exercises.
15+
- [discussions](https://github.com/exercism/discussions) — the place where project-wide conversations happen.
16+
[issues sorted by most recently updated.](https://github.com/exercism/discussions/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
17+
- [xjava](https://github.com/exercism/xjava) — yeah... you know what this one is. :)
18+
- [todo](https://github.com/exercism/todo) — not really used... might just go away completely in the future.
19+
20+
## Maintainer Guides
21+
22+
- **[exercism.io/docs/maintaining-a-track.md](https://github.com/exercism/exercism.io/blob/master/docs/maintaining-a-track.md)**
23+
- [exercism.io/docs/getting-involved-in-a-track.md](https://github.com/exercism/exercism.io/blob/master/docs/getting-involved-in-a-track.md)
24+
- [exercism.io/docs/reviewing-a-pull-request.md](https://github.com/exercism/exercism.io/blob/master/docs/reviewing-a-pull-request.md)
25+
26+
## The Project Board
27+
28+
GitHub issues are great, there's no way to easily set priorities.
29+
To do this, we're using a GitHub Project: https://github.com/exercism/xjava/projects/2.
30+
31+
- **Epics** — issues that really represent bigger ideas. These inspire creating a set of smaller issues to be elaborated...
32+
- **Icebox** — issues that just needs a little more detail to be "ready to play"...
33+
- **Backlog** — issues ready to be worked. When we start working on an issue, we move it to the next column...
34+
- **Current** — issues in progress. When we've considered it done, we move the card to...
35+
- **Delivered** — completed issues that could use another pair of eyes. When these are reviewed they get moved to...
36+
- **Done** — issues we've complete. Every so often, we get together and it's nice to review what we've completed.
37+
Once reviewed, we remove them from this Project.
38+
39+
The point of this board is to make clear our shared priorities. It's a tool you can use.
40+
However, if you have an idea and want to implement it, you can just do it; it does not have to be added to this board.
41+
42+
## Miscellaneous
43+
44+
- Issues marked with "policy" are current "team agreements": [exercism?label:policy](https://github.com/search?q=org%3Aexercism+label%3Apolicy).
45+
This label is described in [discussions#96](https://github.com/exercism/discussions/issues/96).
46+
- Exercism has a Twitter account: [@Exercism.io](https://twitter.com/exercism_io); and a mailing list: https://tinyletter.com/exercism
47+
48+
**Please feel free to ask any questions. In our thinking, asking questions is far smarter than guessing.**

0 commit comments

Comments
 (0)