Github issues and pull requests

This page contains recommendations common to both issues and pull requests. For more information about something specific, refer to the relevant page.

Table Of contents

1. Tense
2. Title
3. Labels
   1. How to copy labels from one repo to another?

---

Tense

Issues and pull requests must be written in imperative, present tense as well as git commits.

Title

Title must briefly explain the change.

• Must have size of 50 characters or 72 maximum as well as Git commits (this rule applies only to the title)
• Must follow git commit syle guide for subject line
  • If it is a complex issue that involves differen types of changes, then use of type can be avoided and issue must be broken down in sub-issues.

Structure a title as you structure a subject line for a commit message:

<type>(<optional scope>): <description>

Labels

Labels are mandatory and needed to categorize issues and pull requests.

Most of the labels are the same as the types in Git commit guide, while the others are self-explanatory.

---

How to copy labels from one repo to another?

For this you need to have github-cli installed on your machine and be logged in Github via gh auth login.

1. Clone the repo you want to copy labels to.
2. Run

   gh label clone <repo_link>
   

   Where <repo_link> is the link to a repo you want to clone labels from.

   • If you want, you can use my repo with all common labels

     gh label clone https://github.com/infgotoinf/BT
     

---

Table of contents

• Issues
• Pull requests