Skip to content

Branch naming scheme

weegee edited this page Jun 11, 2020 · 2 revisions

Naming scheme

Depending upon your issue, the basic format for a branch name is

{your-name}/issue-{issue-number}

We request you follow these guidelines strictly. If your issue does not have a issue number assigned to it (i.e it's not opened) then you are required to open an issue about it, if it'sB a minor detail then you may not need to open a issue for it and you can follow this convention.

{your-name}/issue-{topic}

Here, {topic} can be any of the following

  1. Docs
  2. Code
  3. Typo

Another thing to make sure that before PR merging, if the issue is found out to be not a minor detail and you have still created a PR for it then you are required to at least open the issue for it, link it in the PR body and then proceed.

Clone this wiki locally