Skip to content

Commit 5b00512

Browse files
committed
Add document on sprint-kanban based workflow
1 parent dc015bb commit 5b00512

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

CONTRIBUTING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Team Process
2+
3+
Our team process involves scrum-style practices with some key differences
4+
5+
* We don't have definite sprints. Our backlog is fluid and re-evaludated every week.
6+
* We don't story-point. We should, but we aren't ready to do this yet.
7+
8+
## States
9+
10+
### `Triage`
11+
12+
> Technical contributors: We aren't sure if we should do this, how hard it will be, or if we have enough information.
13+
14+
`Triage` work may be necessary in the indefinite future, but has not been researched. This is the requirements gathering state.
15+
16+
### `Backlog`
17+
18+
> Technical contributors: We know we can and should do this. We aren't ready to do it yet.
19+
20+
`Backlog` work has been reviewed (asyncrhonously) by the whole team and deemed to be necessay and adequately understood.
21+
22+
### `Ready`
23+
24+
> Technical contributors: We should do this as soon as we have time.
25+
26+
`Ready` work has been reviewed synchronously by the whole team and accepted for immediate pickup.
27+
28+
### `Done`
29+
30+
> Technical contributors: We did this, and it's merged to main. Please verify that we met the criteria.
31+
32+
`Done` work has been completed by the technical team and requires review from team lead and stakeholders.
33+
34+
## Responsibilities
35+
36+
* Team leads and stakeholders
37+
* Can propose new work, which becomes `Triage`
38+
* Are solely responsible for maintaining priority in `Triage`.
39+
* Help technical team maintain priority in `Backlog`.
40+
41+
* Technical contributors
42+
* Can also propose new work, which can become `Backlog` or `Triage` depending on scope.
43+
* Are responsible for taking action on high-priority `Triage` work, moving it into the backlog.
44+
* Are responsible for gathering additional information or pushing back against `Triage` work.
45+
46+
## Meetings
47+
48+
Our team has a single weekly meeting. The goals of this meeting, in order of priority, are:
49+
50+
1. To verify the correctness of `Ready`
51+
2. To verify the correctness of `Backlog`, and promote work to `Ready` if appropriate.
52+
3. To review `Done` and verify that requirements have been met.
53+
54+
## Development
55+
56+
Install https://github.com/Kitware/ldc
57+
58+
```bash
59+
# copy .env.example and make any changes
60+
cp .env.example .env
61+
62+
# bring the server up
63+
ldc up -d
64+
65+
# replace a pre-built image with the development version
66+
# for example, here's how to work on the girder server code
67+
ldc dev up girder
68+
```
69+
70+
To work on the Vue client, see development instructions in `./client`.

0 commit comments

Comments
 (0)