interns/CONTRIBUTING.adoc

Table of Contents

• Intern stand-up reports
• Labels
• Milestones
• Boards
• Questions?

This page documents some of the key features of this repository and how someone should navigate it. It describes how a mentor should triage and organize the repository, and it describes to interns about what to watch for when using this repository.

Intern stand-up reports

During each week’s intern stand-up call, each Fedora intern is expected to prepare a weekly report delivered as a presentation, no longer than seven minutes. While 1:1 meetings will use the individualized log sheets, the team stand-up reports provide updates to your mentor team as well as your peers. Your report should include an overview of the following:

1. Progress update on in-progress issues assigned to you.

2. What else you have accomplished in the last week, outside of the issues and issue board.

3. What you hope to accomplish in the next week.

4. Anything you are stuck on or not sure how to solve.

You can present this verbally or with a visual aid (e.g. presentation / slide deck).

Labels

This repository uses labels as a tool to visually represent different information in the issue tracker. Specifically, there are a few scoped labels. A scoped label is a member of a group of labels, and only one of the labels in that group can be used per issue. You cannot tag an issue with two scoped labels of the same group.

The table below describes the different types of labels used in this repository. Any label that uses two colons (::) is a scoped label. Every issue should be labeled with category:: and scope:: labels. Issues in progress or ready for review should be labeled with the appropriate state:: label.

Table 1. GitLab Labels used in Intern Command Center

Label	Description
?::	Issues where action or more information is needed. Usually something that can be resolved quickly.
category::	The type of task or skills needed to address an issue. What kind of background is needed to solve an issue?
good first issue	Issues that are perfect for starting off your internship.
help wanted	Issues that an intern can start working on right away.
scope::	This label helps us understand the ratio of new projects/tasks in comparison to maintenance tasks of existing projects. At the beginning of the internship, expect to see more yellow scope::new labels used. Toward the second half of the internship, there should be a good balance between those and the green scope::improvement labels.
state::	Indicates the current status of an issue. Some of these labels also trigger different behaviors on the issue board (see below).

Milestones

Milestones are one of the most useful views in the Intern Command Center. The internship period is divided into two-week sprint cycles. We will always plan our work in two-week cycles. GitLab Milestones lets us tag issues to specific sprints and visualize progress in interesting ways.

Use GitLab Milestones to track tasks that you are focused on in the current two-week cycle, and also to plan ahead for work in future sprints.

Boards

See this issue board to get a kanban-like view of the progress on all GitLab issues. Here, it is easy to visually see the movement of pending, in progress, and completed tasks. Keeping issue labels and milestones up-to-date will trigger different actions automatically on the issue board. The issue board is what will be reviewed during each weekly stand-up call and during the intern report readouts.

Questions?

If you have questions about how this repository works or if you have ideas on how to make it better, first ask your peers in the intern chat room on Matrix. If the question remains unclear or if others agree with an improvement, bring it to the attention of a mentor during stand-up or in a 1:1 call.