Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update product.md

Browse Source 
change post sync with dan
This commit is contained in:
0xSage 2023-12-18 22:22:19 +08:00 committed by GitHub
parent 9398b734a1
commit 0551d6ddbd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/docs/handbook/product.md
View File

@ -2,7 +2,7 @@
title: Product title: Product
--- ---
We use Github for 100% of our product / project management. We use the [Jan Monorepo Project](https://github.com/orgs/janhq/projects/5) in Github for 100% of our product / project management.
As much as possible, everyone owns their respective `epics` and `tasks`. As much as possible, everyone owns their respective `epics` and `tasks`.
@ -10,21 +10,22 @@ As much as possible, everyone owns their respective `epics` and `tasks`.
## Organization ## Organization
[`Projects`](https://github.com/janhq/jan/projects?query=is%3Aopen) [`Project Labels`](https://github.com/janhq/jan/issues/labels)
- `Projects` track large, long-term, & strategic initiatives that can span multiple teams and multiple sprints - `Project Labels` tag large, long-term, & strategic projects that can span multiple teams and multiple sprints
- Example label: `project: Jan has Mobile`
- `Projects` contain `epics` - `Projects` contain `epics`
[`Epics`](https://github.com/janhq/jan/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+epic%22) [`Epics`](https://github.com/janhq/jan/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+epic%22)
- `Epics` track large stories that span 1-2 weeks, and it outlines specs, architecture decisions, designs - `Epics` track large stories that span 1-2 weeks, and it outlines specs, architecture decisions, designs
- Each `epic` corresponds with a Github `milestone` - Each `epic` corresponds with a `milestone`
- `Epics` contain `tasks` - `Epics` contain `tasks`
- `Epics` should only have 1 owner - `Epics` should always have 1 owner
[`Milestones`](https://github.com/janhq/jan/milestones) [`Milestones`](https://github.com/janhq/jan/milestones)
- `Milestones` correspond 1:1 to `epics` and are used to filter [Project Views](https://github.com/orgs/janhq/projects/5/views/1) - `Milestones` correspond 1:1 to `epics` and are used to filter [Roadmap Views](https://github.com/orgs/janhq/projects/5/views/12)
- `Milestones` span 1-2 weeks and have deadlines - `Milestones` span 1-2 weeks and have deadlines
[`Tasks`](https://github.com/janhq/jan/issues) [`Tasks`](https://github.com/janhq/jan/issues)
@ -32,7 +33,7 @@ As much as possible, everyone owns their respective `epics` and `tasks`.
- Tasks are individual issues (feats, bugs, chores) that can be completed within a few days - Tasks are individual issues (feats, bugs, chores) that can be completed within a few days
- Tasks under `In-progress` and `Todo` should always belong to a `milestone` - Tasks under `In-progress` and `Todo` should always belong to a `milestone`
- Tasks are usually named per [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) - Tasks are usually named per [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
- Tasks should only have 1 owner - Tasks should always have 1 owner
We aim to always work on `tasks` that belong to a `milestones`. We aim to always work on `tasks` that belong to a `milestones`.