From 4e0a5a8e1dfb6af24f84ca2b8aa94c7050754a3d Mon Sep 17 00:00:00 2001 From: Hannah Date: Wed, 1 May 2024 18:15:02 +0700 Subject: [PATCH 1/5] Quick project writeup --- docs/devGuide/projectManagement.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/devGuide/projectManagement.md b/docs/devGuide/projectManagement.md index 02034a51d..ae96b9dda 100644 --- a/docs/devGuide/projectManagement.md +++ b/docs/devGuide/projectManagement.md @@ -362,6 +362,28 @@ Note that: * Some time later: "@all-contributors please add tlylt for doc" * Result: 'tlylt' will be updated to have both icons(code and doc) +## Managing the repository + +### Projects +As the number of issues increase, prioritising and triaging work may become more tricky even with labels. We may want to prioritise certain issues for particular version releases, or to work towards an overall vision of MarkBind. For this purpose, it may be useful to use [GitHub Projects](https://github.com/MarkBind/markbind/projects?query=is%3Aopen). + +#### Instructions: + +1. Read through the issues in the repository to understand what's in the backlog +1. Decide what goals the team is working towards. Examples: "Better Logging", "Necessary Updates", "User Demand", "Bugfix", and "Developer Experience" +1. Make the project (keeping in mind how long it should take) and update the project details +1. Add relevant issues to the project and use it to track progress + +#### Some tips / principles from current use: + +* **Don't treat the project as a strict guide**, only a tool to prioritise tasks and discover issues to work on. If another issue catches your fancy or an urgent fix comes up that is not on the roadmap, you can work on that instead. +* These projects are "product roadmaps" to **help teams communicate and collaborate**. +* [This roadmap](https://github.com/MarkBind/markbind/projects/4) tracks some bigger issues that MarkBind might look towards. +* The main goal is to **triage issues** and perhaps **track progress** in the repository perhaps on a yearly basis. + * You can **triage issues into more than just "todo"** - [this roadmap](https://github.com/orgs/MarkBind/projects/1/views/4) used in 2024 into "KIV/Discussion", "Todo", and "Implementation Needed"; the latter is used for issues that are very straightforward, while the first was used for issues where the precise implementation might require some discussion or be more complex. + * You can **write project details** to clarify your project organisation + * You can use **multiple views** - eg kanban, tables, calendar. Pick what makes sense. + * You can use **custom fields** - [this roadmap](https://github.com/orgs/MarkBind/projects/1/views/5) used in 2024 categorised the issues into bigger picture goals that were set earlier ## Other Notes From 39ec12cbbea4e01163484e9fd9ad723b1e43ad19 Mon Sep 17 00:00:00 2001 From: Hannah Date: Wed, 1 May 2024 20:47:02 +0700 Subject: [PATCH 2/5] Fix additional link --- docs/userGuide/gettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md index 696521e6f..41da6f2cf 100644 --- a/docs/userGuide/gettingStarted.md +++ b/docs/userGuide/gettingStarted.md @@ -74,7 +74,7 @@ You can add the `--help` flag to any command to show the help screen.
-The `init` command populates the project with the [default project template](https://markbind-init-typical.netlify.com/). Refer to [templates](templates.html) section to learn how to use a different template. +The `init` command populates the project with the [default project template](https://markbind-init-typical.netlify.app/). Refer to [templates](templates.html) section to learn how to use a different template. From c84f928f7b937f1078d6411a443ee6abeae47907 Mon Sep 17 00:00:00 2001 From: Hannah Date: Wed, 1 May 2024 21:46:32 +0700 Subject: [PATCH 3/5] Revert "Fix additional link" This reverts commit 39ec12cbbea4e01163484e9fd9ad723b1e43ad19. --- docs/userGuide/gettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md index 41da6f2cf..696521e6f 100644 --- a/docs/userGuide/gettingStarted.md +++ b/docs/userGuide/gettingStarted.md @@ -74,7 +74,7 @@ You can add the `--help` flag to any command to show the help screen.
-The `init` command populates the project with the [default project template](https://markbind-init-typical.netlify.app/). Refer to [templates](templates.html) section to learn how to use a different template. +The `init` command populates the project with the [default project template](https://markbind-init-typical.netlify.com/). Refer to [templates](templates.html) section to learn how to use a different template. From ea8e8d2bcaf1473f19c287e3ef198a0a42cbee07 Mon Sep 17 00:00:00 2001 From: Hannah <59471320+kaixin-hc@users.noreply.github.com> Date: Wed, 1 May 2024 23:50:13 +0700 Subject: [PATCH 4/5] Apply wording suggestions from code review Co-authored-by: Elton Goh Jun Hao <75515229+EltonGohJH@users.noreply.github.com> --- docs/devGuide/projectManagement.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/devGuide/projectManagement.md b/docs/devGuide/projectManagement.md index ae96b9dda..80d3cdfd4 100644 --- a/docs/devGuide/projectManagement.md +++ b/docs/devGuide/projectManagement.md @@ -365,24 +365,24 @@ Note that: ## Managing the repository ### Projects -As the number of issues increase, prioritising and triaging work may become more tricky even with labels. We may want to prioritise certain issues for particular version releases, or to work towards an overall vision of MarkBind. For this purpose, it may be useful to use [GitHub Projects](https://github.com/MarkBind/markbind/projects?query=is%3Aopen). +As the number of issues increases, prioritising and triaging work may become more tricky even with labels. We may want to prioritise certain issues for particular version releases, or to work towards an overall vision of MarkBind. For this purpose, it may be useful to use [GitHub Projects](https://github.com/MarkBind/markbind/projects?query=is%3Aopen). #### Instructions: 1. Read through the issues in the repository to understand what's in the backlog 1. Decide what goals the team is working towards. Examples: "Better Logging", "Necessary Updates", "User Demand", "Bugfix", and "Developer Experience" -1. Make the project (keeping in mind how long it should take) and update the project details +1. Create the GitHub project (keeping in mind how long it should take) and update the project details 1. Add relevant issues to the project and use it to track progress #### Some tips / principles from current use: * **Don't treat the project as a strict guide**, only a tool to prioritise tasks and discover issues to work on. If another issue catches your fancy or an urgent fix comes up that is not on the roadmap, you can work on that instead. * These projects are "product roadmaps" to **help teams communicate and collaborate**. -* [This roadmap](https://github.com/MarkBind/markbind/projects/4) tracks some bigger issues that MarkBind might look towards. +* [This roadmap](https://github.com/MarkBind/markbind/projects/4) tracks some bigger issues that MarkBind aims to focus on. * The main goal is to **triage issues** and perhaps **track progress** in the repository perhaps on a yearly basis. * You can **triage issues into more than just "todo"** - [this roadmap](https://github.com/orgs/MarkBind/projects/1/views/4) used in 2024 into "KIV/Discussion", "Todo", and "Implementation Needed"; the latter is used for issues that are very straightforward, while the first was used for issues where the precise implementation might require some discussion or be more complex. * You can **write project details** to clarify your project organisation - * You can use **multiple views** - eg kanban, tables, calendar. Pick what makes sense. + * You can use **multiple views**, such as Kanban, tables, or calendar, depending on what best suits your needs. * You can use **custom fields** - [this roadmap](https://github.com/orgs/MarkBind/projects/1/views/5) used in 2024 categorised the issues into bigger picture goals that were set earlier ## Other Notes From 4c510ced640dd591d6463c4dd87cd08353fd830d Mon Sep 17 00:00:00 2001 From: EltonGohJH Date: Thu, 2 May 2024 11:45:38 +0800 Subject: [PATCH 5/5] Add periods to the end of the sentences --- docs/devGuide/projectManagement.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/devGuide/projectManagement.md b/docs/devGuide/projectManagement.md index 80d3cdfd4..fe41cdbeb 100644 --- a/docs/devGuide/projectManagement.md +++ b/docs/devGuide/projectManagement.md @@ -369,10 +369,10 @@ As the number of issues increases, prioritising and triaging work may become mor #### Instructions: -1. Read through the issues in the repository to understand what's in the backlog -1. Decide what goals the team is working towards. Examples: "Better Logging", "Necessary Updates", "User Demand", "Bugfix", and "Developer Experience" -1. Create the GitHub project (keeping in mind how long it should take) and update the project details -1. Add relevant issues to the project and use it to track progress +1. Read through the issues in the repository to understand what's in the backlog. +1. Decide what goals the team is working towards. Examples: "Better Logging", "Necessary Updates", "User Demand", "Bugfix", and "Developer Experience". +1. Create the GitHub project (keeping in mind how long it should take) and update the project details. +1. Add relevant issues to the project and use it to track progress. #### Some tips / principles from current use: @@ -381,9 +381,9 @@ As the number of issues increases, prioritising and triaging work may become mor * [This roadmap](https://github.com/MarkBind/markbind/projects/4) tracks some bigger issues that MarkBind aims to focus on. * The main goal is to **triage issues** and perhaps **track progress** in the repository perhaps on a yearly basis. * You can **triage issues into more than just "todo"** - [this roadmap](https://github.com/orgs/MarkBind/projects/1/views/4) used in 2024 into "KIV/Discussion", "Todo", and "Implementation Needed"; the latter is used for issues that are very straightforward, while the first was used for issues where the precise implementation might require some discussion or be more complex. - * You can **write project details** to clarify your project organisation + * You can **write project details** to clarify your project organisation. * You can use **multiple views**, such as Kanban, tables, or calendar, depending on what best suits your needs. - * You can use **custom fields** - [this roadmap](https://github.com/orgs/MarkBind/projects/1/views/5) used in 2024 categorised the issues into bigger picture goals that were set earlier + * You can use **custom fields** - [this roadmap](https://github.com/orgs/MarkBind/projects/1/views/5) used in 2024 categorised the issues into bigger picture goals that were set earlier. ## Other Notes