From 183c8da69fcffb6ef17e56123ac80e81d87714a6 Mon Sep 17 00:00:00 2001
From: toscalix <agustin.benito@codethink.co.uk>
Date: Thu, 24 May 2018 10:59:34 +0200
Subject: [PATCH] added a new section for updating gitlab elements. Filled them
out.
---
BuildStream_policies.md | 57 ++++++++++++++++++++++++++++++++---------
1 file changed, 45 insertions(+), 12 deletions(-)
diff --git a/BuildStream_policies.md b/BuildStream_policies.md
index 67963b0..1acd70b 100644
--- a/BuildStream_policies.md
+++ b/BuildStream_policies.md
@@ -4,7 +4,7 @@
Every policy related with hacking or developing BuildStream is described in the technical documentation: <https://buildstream.gitlab.io/buildstream/HACKING.html>
-## Gitlab elements used at BuildStream.
+## BuildStream on Gitlab: policies
Description of the main elements on Gitlab used at BuildStream.
@@ -83,7 +83,7 @@ Check the templates used at BuildStream:
* bug template: https://gitlab.com/BuildStream/nosoftware/alignment/blob/master/.gitlab/issue_templates/bug.md
* Merge request template: https://gitlab.com/BuildStream/buildstream/blob/master/.gitlab/merge_request_templates/bst_merge_request.md
-## Bugs and technical/engineering tasks: best practices.
+## Technical/engineering tasks: best practices.
These are the best practices that are applied to Gitlab at BuildStream in relation with bugs and tasks. Please read them carefully and try to apply them.
@@ -108,7 +108,22 @@ In order to open a new task the best place is the green button at this page: <ht
* The MR associated with the ticket. Please do not forget this.
* If your issue remains unprocessed after a few days/weeks, please ask through the project mailing list about it. It should be the exception but it might have been overlooked or remain unnoticed.
+### Update an engineering task / ticket
+Assuming the bulk of the work on engineering tasks takes places on Merge Requests (code), it is strongly recommended that you follow these advices:
+* Assign the ticket to you when you start working on it. More than one person can be assigned to a single task.
+* Assign the correct milestone and labels if they are not in place already.
+ * If the task is being executed, please assign the label "Doing", removing the "ToDo" label.
+ * Fill out the "Related Issues" field if there are other bugs or tasks that have a dependency or are related with the one it is being executed.
+* Update the ticket when a relevant event takes place. In any case, update the ticket every couple of days.
+ * This is very important for others to follow up your work.
+
+### Close an engineering task
+
+(coming soon)
+
+## Bugs: best practices
+
### Open/create a bug
In order to open a new bug the best place is the green button at this page: <https://gitlab.com/BuildStream/buildstream/issues>. Please follow these considerations:
@@ -126,11 +141,26 @@ In order to open a new bug the best place is the green button at this page: <htt
* Further considerations:
* Please refer to the considerations made for issues since they also apply to this case.
+### Update a bug
+Assuming the bulk of the work on bugs takes places on Merge Requests (code), it is strongly recommended that you follow these advices:
+* Assign the bug to you. More than one person can be assigned to a single bug.
+* Assign the correct milestone and labels if they are not in place already.
+ * If the bug is being investigated or resolved, please assign the label "Doing", removing the "ToDo" label.
+ * Fill out the "Related Issues" field if there are other bugs or tasks that have a dependency or are related with the one it is being executed.
+* Update the ticket when a relevant event takes place. In any case, update the ticket every couple of days.
+ * This is very important for others to follow up your work.
+
## Merge requests: best practices.
These are the different policies that the project applies to merge requests.
+### Close a Bug
+
+(coming soon)
+
+## Merge requests (MR): best practices
+
### Open/create a merge request
Please read carefully the following policies before opening a new merge request. The best place to create a new merge request is this page: <https://gitlab.com/BuildStream/buildstream/merge_requests>. Please follow these considerations:
@@ -147,16 +177,15 @@ Please read carefully the following policies before opening a new merge request.
* If you want to notify somebody about the merge request, please add his/her name as first comment, starting by the character "@". Try to avoid naming people for notification reasons in the merge request description field.
* If your merge request remains unprocessed for over a week, please ask through IRC (#buildstream in irc.gonme.org) about it. It should be the exception but it might have been overlooked, remain unnoticed or the default reviewer is overloaded.
-### Update tasks / tickets
-
-Assuming the bulk of the work on engineering tasks and bugs takes places in Merge Requests, it is strongly recommended that you follow these advices:
-* Assign the ticket to you when you start working on it.
-* Assign the correct milestone and labels if they are not in place.
- * If the task is being executed, please assign the label "Doing".
- * Fill out the related tasks field if there are other tickets that have a dependency or are related with the one is being executed.
-* Update the ticket when a relevant event takes place. In any case, update the ticket every couple of days.
- * This is very important for others to follow up your work.
-
+### Update a merge request
+
+It is strongly recommended that you follow these advices:
+* Assign the Merge Request to you when you start working on it. Please remember than more than one person can be assigned to the MR.
+* Assign the correct milestone and labels if they are not in place already.
+ * If the MR is in progress, please assign to it the label "Doing", removing the "ToDo" label if present.
+ * every MR should be related in the description field to at least one engineering task or bug. Please check this is the case.
+* Update the MR when a relevant event takes place.
+
## Suggest improvements or additions to the BuildStream policy
If the suggestion refers to coding or hacking the BuildStream code related policies, please create a MR to the technical documentation: <https://gitlab.com/BuildStream/buildstream/tree/master/doc/source>
@@ -164,3 +193,7 @@ If the suggestion refers to coding or hacking the BuildStream code related polic
If the suggestion refers to how to manage tickets, bugs or merge requests or any other topic not directly related with coding, please create a MR to this policy instead of editing this wiki page: <https://gitlab.com/BuildStream/nosoftware/alignment/blob/master/BuildStream_policies.md>
You can always send the proposal to the <mailto:buildstream-list@gnome.org> mailing list if any of the options above fits or you are unsure about what to do.
+
+### Close a Merge Request
+
+(coming soon)
--
GitLab