Commit ba29cd7a authored by toscalix's avatar toscalix
Browse files

Made a small correction on the structure. This is a commit to evaluate the... 

Made a small correction on the structure. This is a commit to evaluate the integration between Gitlab and the mailing list.
parent 183c8da6

BuildStream_policies.md

+16 −14
Original line number Diff line number Diff line
@@ -83,11 +83,11 @@ 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



## 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.



### Open/create a technical issue

#### Open/create a technical issue



In order to open a new task the best place is the green button at this page: <https://gitlab.com/BuildStream/buildstream/issues>. Please follow these considerations:

* Use the default template.
@@ -108,7 +108,7 @@ 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

#### 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.
@@ -118,13 +118,13 @@ Assuming the bulk of the work on engineering tasks takes places on Merge Request 
* 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

#### Close an engineering task



(coming soon)

    

## Bugs: best practices

### Bugs: best practices

    

### Open/create a bug

#### 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:

* Use the Bug template. Choose it from the template menu when creating a new bug.
@@ -141,7 +141,7 @@ 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

#### 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.
@@ -155,13 +155,13 @@ Assuming the bulk of the work on bugs takes places on Merge Requests (code), it 


These are the different policies that the project applies to merge requests.



### Close a Bug

#### Close a Bug



(coming soon)



## Merge requests (MR): best practices

### Merge requests (MR): best practices



### Open/create a merge request

#### 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:

* Use the default template.
@@ -177,7 +177,7 @@ 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 a merge request

#### 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.
@@ -186,6 +186,11 @@ It is strongly recommended that you follow these advices: 
   * 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.



#### Close a Merge Request



(coming soon)



	

## 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>
@@ -194,6 +199,3 @@ If the suggestion refers to how to manage tickets, bugs or merge requests or any 


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)