Skip to content

Commit e61433c

Browse files
committed
docs: add info about linear (temp, due for overhaul)
1 parent a7ae1ce commit e61433c

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

docs/dev-practices.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,3 +422,64 @@ These stages go in order, from local development, through to production deployme
422422
- The workflow will deploy to the server remotely when the branch is pushed to.
423423
- This approach is less preferred, as the user requires write access to the
424424
Github repo.
425+
426+
## Note About Linear
427+
428+
- The information above is due to an overhaul!
429+
- We have decided to use Linear as a project management tool,
430+
allowing for easier thematic linking of tasks across projects.
431+
- The Linear tool itself is only accessible by HOT staff, but
432+
absolutely everything there is synced publicly and bi-directionally
433+
to Github!
434+
435+
### Issue management
436+
437+
- **Issues**: lowest level, per repo.
438+
- Each issue should have a label `repo:repo-name` to allow for
439+
easier sorting in Linear (a small workaround to ensure we
440+
remain on the 'free' tier).
441+
- Issues and all info are synced automatically from Github,
442+
but the only manual step we need is adding the mentioned
443+
label.
444+
- Developers should interact and comment on Github issues.
445+
- Managers can track progress, group issues, and make
446+
dashboards via Linear.
447+
- 💡 Example: Add additional endpoints to backend for gathering
448+
user stats on a dashboard.
449+
- **Milestones**: these are an _optional_ part of the workflow
450+
capturing multiple issues that have a specific _deadline_ and
451+
purpose, e.g. linked to a specific contract.
452+
- 💡 Example: Add badges to user profile, based on stats
453+
generated in each mapping category. Due 29/10/2025.
454+
- **Projects**: a grouping of issues and milestones around a
455+
particular theme, i.e. essentially an epic in other tools.
456+
These can include issues from multiple repos, if they tie
457+
together.
458+
- 💡 Example: Super Mapper feature in Tasking Manager.
459+
- **Initiatives**: a very high level goal we wish to achieve,
460+
encompasing multiple projects.
461+
- 💡 Example: Better user engagement by providing useful
462+
stats and better tracking of mapping progress across
463+
projects.
464+
465+
### Public roadmap
466+
467+
- We have a public roadmap linking all tools together under
468+
[https://hotosm.steelsync.io/tech-roadmap](https://hotosm.steelsync.io/tech-roadmap)
469+
- This is made using a tool called SteelSync (paid unfortunately,
470+
but cheap), that gathers data from the Linear API and easily
471+
creates a public dashboard.
472+
- We chose the approach to save the overhead of developing
473+
our own roadmap page using the Linear API.
474+
475+
### Feature requests
476+
477+
- Technical users can still make issues and bug reports via
478+
each Github repo.
479+
- For general user requests (public, or internal to HOT),
480+
we can all use the 'Request' button available on the
481+
mentioned public roadmap page above.
482+
- Each request will create an issue in Linear. The tech team
483+
will triage and add the issue to the relevant Github code
484+
repository, then place within a project / initative with
485+
timelines.

0 commit comments

Comments
 (0)