Creating a Task within a project - CHI-CityTech/StudentResearch GitHub Wiki

Instructions for Adding a Task Card to the Project Board

Step 1: Navigate to the Project Board

(example: πŸ”— CHI-CityTech Project Board)

  1. Click the Project Board link above or go to:
    GitHub β†’ CHI-CityTech Organization β†’ Projects β†’ Project #43
  2. Ensure you are signed in to your GitHub account.

Step 2: Create a New Task Card

  1. Scroll to the bottom of the board until you see a + sign.
  2. Click the + Add Item button.
  3. In the text box, enter a brief but clear task title (e.g., Research MIDI-to-Qubit Data Conversion).
  4. Press Enter to create the new task card.

Step 3: Convert the Task to an Issue (Recommended)

  1. Click on the newly created task card.
  2. Select "Convert to Issue" (this allows for better tracking and discussion).
  3. Choose the repository where the issue should belong (e.g., StudentResearch).
  4. Click "Convert" to finalize.

Step 4: Add a Detailed Description

  1. Click on the task card to open its detailed view.
  2. In the Description section, provide:
    • A clear explanation of the task.
    • Expected deliverables.
    • Any useful links or references.
  3. DO NOT add the description in the commentsβ€”use the designated Description field.

Step 5: Assign Team Members & Labels

  1. Inside the task card, on the right-hand side:
    • Assign yourself or other team members responsible for the task.
    • Add relevant labels (e.g., "Research," "In Progress," "Urgent," etc.).
    • Set a due date if applicable.

Step 6: Create a Sub-Issue (If Needed)

If a task requires multiple steps or dependencies, you can create sub-issues to break it down further:

  1. Navigate to the main issue that you want to add sub-issues to.
  2. Scroll to the bottom of the issue description and click Create sub-issue.
  3. In the dialog, type a title for the sub-issue.
  4. Optionally, add:
    • A description of the sub-task.
    • Assignees responsible for the sub-issue.
    • Labels, projects, and milestones if applicable.
  5. (Optional) If you want to continue creating sub-issues for this parent issue, select Create more sub-issues.
  6. Click Create to finalize the sub-issue.

Step 7: Move the Task to the Correct Column

  1. Click and drag the task card to the appropriate column:
    • To Do β†’ Not started
    • In Progress β†’ Actively being worked on
    • Done β†’ Completed

Step 8: Update and Close the Task

  1. As work progresses, update the description with any key developments.
  2. Once completed, move the task to "Done" and close the issue (if applicable).

βœ… Task successfully added and tracked on the project board! πŸš€
Let me know if you need further refinements.