Issue

Purpose

In computing, the term "issue" is a unit of work to accomplish an improvement in a system. An issue could be a bug, a requested feature, task, missing documentation, and so forth.

Stage

My Magestore State GitLab Label Description
Open Open and No Label
Doing State: Coding, State: Staging, State: Delivery Ready
Delivery Ready State: Delivery Done
Done Closed with Milestone
Cancel Closed wth Label State: Cancelled

Type

Issue Type Template name Status Link Template GitLab Label Description
Bug Report bug_report Using open Type: Bug To describe Report Bug/Incident need to be fixed for the Customer
Installation installation Deprecated Type: User Story To describe Installation Request to be done for the Customer
User Story user_story Using open Type: User Story To describe Feature need to be done for the Customer
Init POS init_pos Using (new template) open Type: User Story Prepare POS source code to create release then deliver to customer (previously is installation, but according to the release process, we split out the installation process to 2 child processes, init pos and delivery).
Upgrade POS upgrade_pos Using (new template) open Type: User Story Upgrade POS from current version to higher version.
Delivery delivery Using (new template) open Type: Deploy Deliver the released package take from release page to customer by Delivery method on corresponding project.
Question Type: Question To describe question from customer which is must be replied

Relationship

Principles

Installation Checklist Template

Checklist Description
Project has SSH and Admin Information in Wiki Page Người tạo issue (có thể là quản lý dự án hoặc người khác) chắc chắn rằng dự án đã đầy đủ thông tin về SSH, Admin để developer có thể tiến hành cài đặt mà không phải đặt thêm câu hỏi gì nữa.
POS package installed successfully Developer cài đặt bộ sản phẩm POS trên site khách hàng không gặp vấn đề gì, ví dụ như lỗi permission, đang cài bị lỗi, hạn chế IP...
Those features working fine on POS after installation Những tính năng cơ bản của POS sau khi cài mà developer phải check lại sau khi cài đặt POS trên site khách, những tính năng ở checklist nhỏ bên trong là các tính năng
POS source code (client, server) added to the project repository Sau khi cài xong developer phải thực hiện việc lưu trữ code đã cài cho khách hàng lên Repository của team để quản lý, nếu sau này có lỗi, phát sinh customize thì có thể dùng ngay.
Lưu ý: sau khi cài nên tạo 1 commit chỉ lưu trữ code gốc khi ra lấy từ product sang, những bản vá lỗi sau này tạo thành 1 commit khác.
All the patch (if have) after installation added to project repository Tất cả những bản vá lỗi của POS sau khi cài đặt (nếu có) trên site khách hàng cũng cần lưu trữ lại để đảm bảo code lưu trữ đồng bộ với phiên bản trên site khách.
Project Wiki updated (if any information changed during installation) Trong quá trình cài đặt POS nếu khách hàng có cung cấp thêm thông tin, hoặc thông tin trong Wiki chưa được chính xác thì phải cập nhật lại wiki cho những người sử dụng sau.
Coding Standard Implemented Đã implement Coding Standard cho Project để những bản fix bug, customize sau sử dụng được Coding Standard luôn.
Code merged to branch master Nhánh master là nhánh phản ánh code trên site khách, khi cài đặt xong cần đẩy code lên nhánh master hoặc tạo Merge Request đến nhánh master và tự Merge.

Activity

Create GitLab Issue Template for Project

Prerequisite: Make sure you are Maintainer in your GitLab group

  • Step 1: Access your team project on GitLab

  • Step 2: Create new file in one of two ways:

    • If there is no file on this Project

    • If there are some files on this Project

  • Step 3: Pick 1 file template of Issue Type to template to Copy content

  • Step 4: Open and Copy content of the Template to your new File

  • Step 5: Set File Name with format .gitlab/issue_templates/<filename>.md. <filename> is the template name such as .gitlab/issue_templates/bug_report.md

  • Step 6 Change commit message and click Commit

  • Step 7:. Result after complete

  • Step 8: To valid the result, you create a new Issue to the the list of template with <filename> on the below screenshot

  • Step 9: Back to Step 2 with remaining other files template of Issue Type

Create GitLab Issue Template for many Projects by Importing via Git

  • Step 1 Copy project url. Có thể sử dụng clone bằng SSH hoặc HTTPS (khuyến khích clone bằng SSH vì không phải nhập user & password nhiều lần khi push)

  • Step 2: Clone về local với nhánh master: git clone <remote_url> -b master

  • Step 3: Tạo thư mục issue templates mkdir .gitlab/issue_templates

  • Step 4: Tạo những file templates được định nghĩa trong file template of Issue Type

  • Step 5: Thêm templates vào remote git add .gitlab/issue_templates/*

  • Step 6: Commit git commit -m "Add issue templates"

  • Step 7: Push git push -u origin master

  • Step 8: Kiểm tra issue template trên project bằng cách vào Project Isue tạo thử issue mới, phần template sẽ hiện ra những file

Create an Issue

To create Issue from GitLab

  • Step 1: To craete, go to GitLab > Team Board

  • Step 2: Type the name of Issue and choose Project from dropdown list

  • Step 3: Open the Issue to full content. You can choose template from dropdown list if you have setup the template before

To create Issue from My Magestore

  • Step 1: Go to My Magestore > Project, open the Project and open Issue List

  • Step 2: Click +, fill Title

  • Step 3: Click to open the Issue and fill the detail content.

Tips: You can open the Issue on GitLab by click Extra tab and open the Gitlab Task URL

To create Issue from User Story

Notice The Project must be assigned to the Business Requirement Package according to this guide

To create Issue from Slack

To create Issue from Slack

Assign an Issue to an User Story

Notice The Project must be assigned to the Business Requirement Package according to this guide

  • Step 1: Go to My Magestore > Project, open the Project and open Issue List
  • Step 2 Choose User Story from the dropdown líst

Send an Issue to the Customer

Assign a Developer to Issue

Done an Issue

To Done Issue from GitLab

Notice: On GitLab, An Issue is done while it is closed with a Milestone and without State: Cancelled label

  • Step 1: To mark and Issue is done, go to GitLab > Team Board

  • Step 2: Move the Issue to Closed Column.

To Done Issue from My Magestore

  • Step 1: Go to My Magestore > Project, open the Project and open Issue List

  • Step 2: Find to the Issue and move to Done

Cancel an Issue

To Cancel an Issue from GitLab

Notice: On GitLab, an Issue is Done while it is closed with a State: Cancelled label

  • Step 1: To cancel Issue, go to GitLab > Team Board

  • Step 2 Open the Issue and set Label to State: Cancalled

  • Step 3: Move the Issue to Closed Column.

To Cancel an Issue from My Magestore

  • Step 1: Go to My Magestore > Project, open the Project and open Issue List

  • Step 2: Find to the Issue and move to Cancel

Open Issue GitLab from My Magestore

  • Step 1: Go to My Magestore > Project, open the Project and open Issue List

  • Step 2: Open an Issue, move to Extra tab and open the Gitlab Task URL

Set Milestone for an Issue

  • Step 1: Open the Issue on GitLab
  • Step 2: Set Milestone on the right of Issue

Notice You must create your group milestone first

Estimate an Issue

  • Step 1: Open the Issue on GitLab
  • Step 2: On the comment, type the command /estimate time

Tip You can change the estimate time by comment again the new estimate value.

Report Spend Time of an Issue

  • Step 1: Open the Issue on GitLab
  • Step 2: On the comment, type the command /spend time