From e7ca8e517d9b78eedc2bcff0b3130a14949b3d70 Mon Sep 17 00:00:00 2001 From: Evilham Date: Wed, 25 May 2022 13:30:45 +0200 Subject: [PATCH] [docs] Add project management guidelines Since there are many people involved, we should have some general way of doing things. Reviewed with: @cristiano19 and @elena61 --- docs/index.ca.md | 3 +- docs/index.md | 3 +- docs/project-management.md | 82 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 86 insertions(+), 2 deletions(-) create mode 100644 docs/project-management.md diff --git a/docs/index.ca.md b/docs/index.ca.md index fc5c057..0fa2e2c 100644 --- a/docs/index.ca.md +++ b/docs/index.ca.md @@ -1,6 +1,7 @@ # Manual DD (en construcció) -[Instruccions post-instal·lació](../post-install.ca/). +- [Instruccions post-instal·lació](../post-install.ca/). +- [Administració del projecte (en anglès)](./project-management/) diff --git a/docs/index.md b/docs/index.md index 9941aee..500d8d0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,7 @@ # Welcome -[Post-installation steps in Catalan](./post-install.ca/). +- [Post-installation steps (in Catalan)](./post-install.ca/) +- [Project Management](./project-management/) diff --git a/docs/project-management.md b/docs/project-management.md new file mode 100644 index 0000000..167a641 --- /dev/null +++ b/docs/project-management.md @@ -0,0 +1,82 @@ +# Project Management guidelines + +In order to work in a mostly harmonic fashion we need to agree on some +general guidelines in how to manage things like issues, labels, etc. + +## Labels + +Here we document the labels available in this project and how they ought to +be used to organise and prioritise work. + +Please propose any changes through a Merge Request changing this file that can +be reviewed and commented. + +> Any label not listed on this document will be removed in the second half +> of June 2022. + +### Priority + +How an issue should prioritised regarding its importance; note that this +together with `stage::` marks what should be worked on first. + +- `priority::0-wishlist` +- `priority::1-low` +- `priority::2-medium` +- `priority::3-high` +- `priority::4-critical` + +### Stages + +Used to have a high-level overview around particular dates or deadlines; e.g. +congress, school start, summer pause, ... + +- `stage::2022_06` +- `stage::2022_07_congress` +- `stage::2022_08_summer` +- `stage::2022_09_school_start` +- `stage::far_future` + +### Component + +Which parts of the whole system, if any, are affected by this issue. + +> Note that if the issue is in the systems part of a component, we will +> also apply the label `kind::sysadmin`. + +- `component::Menu_Top&Bottom_Bar` +- `component::administration_app` +- `component::api` +- `component::bigbluebutton` +- `component::keycloak` +- `component::monitorization` +- `component::moodle` +- `component::nextcloud` +- `component::nextcloud-forms` +- `component::notifications` +- `component::onlyoffice` +- `component::security-proxy` +- `component::sistemas` +- `component::wordpress` + +### Kind + +General classification of the kind of issue. + +- `kind::automation` +- `kind::bug` +- `kind::documentation` +- `kind::feature` +- `kind::security` +- `kind::sysadmin` +- `kind::testing` + +### Workflow + +Solving issues should follow this cycle: + +- `workflow::0-triage` +- `workflow::1-todo` +- `workflow::2-in_progress` +- `workflow::3-done_to_review` +- `workflow::4-in_testing` +- `workflow::5-ready_to_deploy`