Adding labels in the research repository

Last Updated: December 4, 2024

Labels in the GitHub research repository board help fellow researchers and team members find previous studies. You can help by adding appropriate labels to your study issue in the research repo board. You can also help by adding new labels as needed.

Helpful links

• Research repo board on GitHub

• List of labels on GitHub

When to add or create labels

Add labels to your study's GitHub issue in the research repo board during the following steps in the research checklist. Note that you might need to create new labels.

• Step 2: Research review

  • Start adding labels to your issue when you add your study to the repo board.

• Step 6: Synthesize data

  • After writing your research findings, add any other relevant labels to your issue on the repo board.

How to add or create labels

Follow these steps to add or create labels:

1. Check if your label exists already by reviewing labels in GitHub. You can search by different label types. See different types of labels below.

2. If you need a new label:

   1. Select "New Label" button in the top right corner of the lists

   2. Label name: Enter the label name with the following naming convention

      1. [Type of label in all caps]: [Name]

      2. Example: PRDT: My VA

   3. Description: Enter the description for the type of label

      1. Example: If the type of label is AUD, enter Audience

   4. Color: Copy the corresponding hex code in the types of labels table below.

   5. Select "Create Label" button to save your new label

3. If you don't need a new label:

   1. Open your study issue in the research repo board in GitHub

   2. Select the gear icon in the "Labels" section

   3. Select any labels you'd like to add to your study

Types of labels

Cleaning up existing labels

If your team currently uses labels that don't follow these guidelines, please reach out to Shane and Becky in the #research-ops channel.

Help and feedback

• Suggest content changes to this page.

• Submit new Platform Website content.

• Get help from the Platform Support Team in Slack.

• Submit a feature idea to the Platform.