Skip to content

cheat-sheet.md

Latest commit

 

History

History
148 lines (105 loc) · 5.51 KB

cheat-sheet.md

File metadata and controls

148 lines (105 loc) · 5.51 KB

GitHub Common Tasks Cheat Sheet

Quick Reference for Farmers --- Step-by-step instructions for the tasks you'll do most often

1. Create a New Repository

  1. Click the + button in the top-right corner of any GitHub page
  2. Select "New repository"
  3. Enter a name (e.g., spring-2026-crop-plan)
  4. Add a short description of what the repository is for
  5. Check "Add a README file"
  6. Click "Create repository"

Tip: Use lowercase letters and hyphens in repository names. Avoid spaces.

2. Create a New Issue

  1. Open your repository
  2. Click the "Issues" tab
  3. Click the green "New issue" button
  4. Enter a title that clearly describes the task
  5. In the description, add details, checklists (- [ ] Step one), and context
  6. On the right sidebar, select Labels, Assignee, and Milestone (optional)
  7. Click "Submit new issue"

Tip: Start the title with an action verb: "Repair north fence," "Order spring seed," "Schedule vet visit."

3. Create and Apply Labels

  1. Go to the "Issues" tab in your repository
  2. Click "Labels" (next to the Milestones button)
  3. Click "New label"
  4. Enter a name, pick a color, and add a short description
  5. Click "Create label"
  6. To apply: open an Issue, click "Labels" on the right sidebar, and select the label

Tip: Use colors that mean something to you --- red for urgent, green for field work, blue for planning.

4. Set Up a Project Board

  1. Click the "Projects" tab on your repository (or go to your profile > "Your projects")
  2. Click "New project"
  3. Choose a layout (Board is the easiest to start with)
  4. Name your Project (e.g., "Spring 2026 Plan")
  5. Click "Create project"
  6. Click "+ Add item" at the bottom of a column to add existing Issues
  7. Drag Issues between columns (To Do → In Progress → Done)

Tip: Add custom fields (Priority, Season, Cost) by clicking the + next to column headers.

5. Create an Issue Template

  1. Go to your repository's main page
  2. Click "Settings" (the gear icon tab)
  3. Scroll down to the "Features" section
  4. Next to Issues, click "Set up templates"
  5. Click "Add template" → "Custom template"
  6. Fill in the template name, description, and template content (use Markdown for sections and checkboxes)
  7. Click "Propose changes", then "Commit changes"

Tip: Test your template by going to Issues > New issue --- your template should appear as an option.

6. Set Up Iterations on a Project

  1. Open your Project
  2. Click the gear icon (Settings)
  3. Under "Custom fields", click "New field"
  4. Select "Iteration" as the field type
  5. Name it (e.g., "Sprint" or "Week" or "Month")
  6. Set the duration (1 week, 2 weeks, or 1 month)
  7. Click "Save"
  8. Back in the board or table view, assign iterations to your Issues

Tip: Spread tasks across iterations rather than putting everything in the first one.

7. Create a Timeline / Roadmap View

  1. Open your Project
  2. Click the "+" tab (or "New view") at the top
  3. Select "Roadmap" (this is the Timeline view)
  4. Name the view (e.g., "Season Timeline")
  5. If Issues don't appear, switch to Table view and fill in date fields for each Issue
  6. Switch back to Roadmap view --- Issues should now appear on the timeline

Tip: Set dates that match your real farming calendar so the timeline is actually useful.

8. Use Copilot to Draft an Issue

  1. Click "New issue" in your repository
  2. Enter a descriptive title
  3. Click inside the description box
  4. Look for the Copilot icon (sparkle icon) near the text toolbar
  5. Click the icon to open Copilot
  6. Type a detailed prompt describing what you need (be specific about your farm, crops, equipment, or animals)
  7. Review the generated text --- check for accuracy, completeness, and relevance
  8. Edit the draft: delete what's wrong, add what's missing, and adjust for your farm
  9. Apply labels and click "Submit new issue"

Tip: The more detail you put in your prompt, the better the draft. Include farm size, crop types, equipment models, or animal counts.

9. Create a Pull Request

  1. Make changes on a branch (not directly on main)
  2. Go to the repository's main page
  3. Click "Compare & pull request" (the yellow banner) or go to the "Pull requests" tab and click "New pull request"
  4. Select the base branch (usually main) and the compare branch (your branch)
  5. Enter a title and description explaining what you changed and why
  6. Click "Create pull request"
  7. Ask a collaborator to review your changes
  8. Once approved, click "Merge pull request"

Tip: Write your PR description as if explaining the change to a fellow farmer who hasn't seen it yet.

10. Watch a Repository for Notifications

  1. Open the repository you want to follow
  2. Click the "Watch" button near the top-right (next to Star and Fork)
  3. Choose your notification level:
    • Participating and @mentions --- only when you're directly involved
    • All Activity --- every Issue, PR, and comment
    • Custom --- choose specific events
  4. Check notifications by clicking the bell icon in the top-right corner of GitHub

Tip: Start with "Participating and @mentions" to avoid notification overload. Increase later if needed.

Print this sheet and keep it next to your computer. The more you use these steps, the faster they'll become second nature.