Skip to content

Using GitHub Projects

WebCoder49 edited this page Sep 23, 2023 · 5 revisions

☑️ Using GitHub Projects

We use GitHub Projects (GitHub's description; our project) to organise programming tasks. It can be found as the first item in the Projects tab at the top of the repository / wiki. Here's how to use it for the FTC:

Important: Labels

Each task is given one or more labels, and these are custom categories making it clear how you should implement the code to avoid collaboration merge conflicts. Please see the descriptions below, or click on the "Click for label meanings" task in the project:

Label Meaning
🤖 ftc-autonomous Code to be run in the autonomous period (no human interaction)
🎮 ftc-drivercontrolled Code to be run in the driver-controlled (AKA TeleOp[erated]) period (human with gamepad)
📦 ftc-component Code to be written as a separate component Java class in the components folder
🚪 ftc-opmode Code to be written as an OpMode (code entrypoint) - pay attention to whether it is an Autonomous or TeleOp OpMode.

Creating a task

This task could be a bug you found in the production code while testing, or a feature that needs to be created.

  1. Click the + button to create a task
In the Board view In the Table view
image image
  1. Type a name for the task, and press Enter.
  2. Click the name of the draft task created. image
  3. Click Edit. image
  4. Write a description. You can Ctrl+V any images to upload them, then click Update comment. image
  5. You can repeat steps 4-5 in the future to add any more details.
  6. Click Convert to Issue on the right, and select 2024. image
  7. Click the button next to Labels and select labels as given above.
  8. Do the same for Assignees, for whoever the task is for, if it has been agreed.
8 9
image image

Changing the status of Tasks

  1. Enter the Board view.
  2. Click-and-Drag the task to the correct column.
  3. The rest is automated!

Clone this wiki locally