Guidelines Ticket Creation - Code4GovTech/C4GT GitHub Wiki

Guidelines for ticket creation

Please go through the Issue Ticket Template & the Ticket Taxonomy to understand the different sections of the ticket.

  • If you are creating a new ticket, please add our Issue ticket template to your repository.
  • If you are updating a ticket, please use ensure that all the required fields as per the template are added to your ticket.

Please find below some key guidelines to keep in mind while creating/updating your C4GT Ticket

  1. Ticket Detail Section
  • Objective is to help contributors understand the project, outcomes and how to get started
  • Should be self-explanatory to enable the contributors to understand the problem statement.
  • This section need not adhere to what is mentioned in the issue template.
  1. Meta Data
  • This section consists of - Project Name, Product Name, Organisation, GovTech Domain, Tech Skills, Mentor, Complexity, Category & Sub-category. All these details have to mandatorily be mentioned to enable the discovery of tickets.
  • For all sections, please use only the listed options in the ticket. For eg: Complexity: Low, Medium & High. Do not add beginner/amateur/complex etc.
  • For all metadata sub-sections, each element has to be listed with comma separators. For eg: Tech skills will be mentioned - Java, Scala, Angular
  • Mentors to be tagged on the ticket. Ideally, mentors should have their organisations & email listed on their profile for ease of communication.
  • All fields in this section are mandatory to have in the issue ticket. It helps us list the ticket correctly.
  1. Ticket Schemas
  • Please use the issue template to create tickets as it helps us tag the ticket with a ‘C4GT Community’ label to make them automatically discoverable. Each ticket must have this tag to be discoverable. If you are updating a ticket, then please create a label called ‘C4GT Community’ and tag your ticket with the same.