Last updated on 2026-06-08 | Edit this page

đź“– Quick Guide: Working Directly in GitHub

This guide will show you how to create and update your project files entirely inside your web browser. No Repo cloning or downloading required!


Part 1: How to Create a New File Using the Template

Follow these steps when you need to create a brand new project file for the first time.

Step 1: Copy the Template Text

  1. Open your team repository on GitHub.
  2. Click on the template file to open it.
  3. Highlight all the text inside the template, right-click, and select Copy (or use Ctrl+C / Cmd+C).
  4. Click your repository’s name at the top left to go back to your main folder.

Step 2: Go Inside Your Target Folder

  1. Look at your file list and click on the specific folder where your file belongs (for example: the recipes or documentation folder).
  2. Make sure you are inside the folder before moving to the next step!

Step 3: Create the New File

  1. Now that you are inside the correct folder, click the Add file button near the top right.
  2. Select Create new file from the dropdown menu.
Create File

Step 4: Name Your File and Paste the Template

  1. In the box labeled Name your file…, type your new file name.
  • ⚠️ CRITICAL STEP: You must type .md at the very end of your file name (for example: project-update.md).
  1. Click into the big blank text box below the file name.
  2. Right-click and select Paste (or use Ctrl+V / Cmd+V) to drop your template layout inside.
Name File

Step 5: Save (Commit) Your File

  1. Click the green Commit changes… button at the top right of the screen.
  2. A small window will pop up. Click the green Commit changes button inside that window to confirm.

Your file is now live in the correct folder for the whole team to see!


Part 2: How to Edit and Update an Existing File

Follow these steps in later sprints when your file already exists and you just need to add more data, section headings, or deep details.

Step 1: Open the Online Editor

  1. Click on the folder where your file lives, then click on the file you want to change (e.g., project-update.md) to open it.
  2. Look at the top right corner of the file panel and click the Pencil Icon (Edit this file).
Edit File
Edit File

Step 2: Make Your Changes and Save

  1. Type your updates, outlines, or text revisions directly into the screen box.
  2. When you are done editing, click the green Commit changes… button at the top right.
  3. Click Commit changes one more time in the pop-up box to save.
Commit File

📌 Quick Reminders for Beginners

  • Check the Path: Always look at the top-left text string (e.g., repository / folder-name /) right before you click “Create new file” to make sure you are in the right spot!
  • Commit = Save: In GitHub, the word “Commit” just means “Save.” Every time you commit, you are saving a permanent version of your work.
  • Don’t Forget the .md: If your file doesn’t have .md at the end of its name, the text formatting will look broken. You can always rename it using the pencil icon if you forget!