Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 0950f6a

Browse files
committed
docs: add mgmt notes
1 parent aab3796 commit 0950f6a

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

MGMT.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Core Dev Team Work Tracking & Managment
2+
3+
## How work gets organized (a tl;dr;)
4+
5+
The js-ipfs core working group follows the OKR structure established for the IPFS project to set the quarterly targets. Within each quarter, work gets tracked using Github and Waffle.
6+
7+
- Github is used for discussions and track current endeavours.
8+
- Waffle gives us a [Kanban](https://en.wikipedia.org/wiki/Kanban) view over the work at hand.
9+
10+
![](https://ipfs.io/ipfs/QmWNd86qtjyFnygSAHkZDy4fUB1WnRa4WNt8gt1rSiq7of)
11+
12+
In the Waffle board, we have 4 columns:
13+
14+
- **Inbox** - New issues or PRs that haven't been evaluated yet
15+
- **Backlog** - Issues that are blocked or discussion threads that are not currently active
16+
- **Ready** - Issues Ready to be worked on
17+
- **In Progress** - Issues that someone is already tackling. Contributors should focus on a few things rather than many at once.
18+
- **Done** - Issues are automatically moved here when the issue is closed or the PR merged.
19+
20+
We track work for the JavaScript implementation of the IPFS protocol in 3 separate waffle boards:
21+
22+
- [js-ipfs](http://waffle.io/ipfs/js-ipfs)
23+
- [js-libp2p](http://waffle.io/libp2p/js-libp2p)
24+
- [js-ipld](http://waffle.io/ipld/js-ipld)
25+
26+
## Issue labels and how to use filters
27+
28+
We use labels to tag urgency and the difficulty of an issue. The current label system has:
29+
30+
- `difficulty:{easy, moderate, hard}` - This is an instinctive measure give by the project lead or leads. It is a subjective best guess, however the current golden rule is that an issue with difficulty:easy should not require more than a morning (3~4 hours) to do and it should not require having to mess with multiple modules to complete. Issues with difficulty moderate or hard might require some discussion around the problem or even request that another team (i.e go-ipfs) makes some changes. The length of moderate or hard issue might be a day to ad-aeternum.
31+
- `priority (P0, P1, P2, P3, P4)` - P0 is the most important while P4 is the least.
32+
- `help wanted` - Issues perfect for new contributors. They will have the information necessary or the pointers for a new contributor to figure out what is required. These issues are never blocked on some other issue be done first.
33+
34+
## Weekly Core Dev Team Calls
35+
36+
[ⒿⓈ⚡️ js-ipfs Dev Team Weekly Sync 🙌🏽](https://github.com/ipfs/js-ipfs/issues/1179)

0 commit comments

Comments
 (0)