Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.37 KB

ISSUE_AND_PR.md

File metadata and controls

51 lines (33 loc) · 1.37 KB

Guidelines for working on an Issue and PR

Note: This guide will act as a set of rules, that are required to be followed by anyone who is going to work in this project.

CONTENTS

  1. Assignee
  2. Description
  3. Elementary
  4. Label
  5. URL

Assignee

  • Add yourself as assignee before starting to work on an issue
  • Add yourself as assignee before raising PR.

Description

  • While creating a new issue, add proper description in it.
    This is essential if someone else decides to work on issue created by you.

Elementary

  • Create issues of small problems.
    This make sures that your work does not change many files in a single go.
  • Create a PR of single functionality.
  • Make sure to have only your changes in PR.

Label

  • While working on an issue, add appropriate labels on that issue.
    If you are working on issue, add the label in Progress.
    If the PR of issue is merged then remove the label in Progress

  • Before raising a PR, add appropriate labels on that PR.
    If you are working on feature branch add the label feature.

URL

  • Add the url of the ticket in PR.
  • Format for adding url will be ticket : url of PR