Skip to content

brightsign/howto-git

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

GitHub for Non-Coders - Quick Start

A practical guide for non-technical users learning to use GitHub for document collaboration.

Read the full guide here

What This Is

This repository contains a comprehensive guide for using GitHub to collaborate on documents, review content, and contribute changes. Choose your preferred method: web interface, command line, or graphical tools.

Quick Start Paths

Web Interface (No Installation)

  1. Get a GitHub account at https://github.com
  2. Navigate to the repository and file
  3. Click the pencil icon to edit or create issues for comments
  4. Submit pull requests directly from the browser

Command Line

# Install Git (see guide for platform-specific instructions)
git clone git@github.com:organization/repository.git
git checkout -b review/my-feedback
# Make edits
git add file.md
git commit -m "Update requirements: clarify authentication"
git push -u origin review/my-feedback

GitHub CLI

# Install gh CLI (see guide for platform-specific instructions)
gh auth login
gh pr create --title "Update security requirements"
gh pr list
gh pr review 123 --approve

GitHub Desktop (GUI)

Download from https://desktop.github.com

  • Clone repository via File > Clone
  • Create branch, edit files, commit, and create pull request
  • Visual diff and easy conflict resolution

Essential Concepts

  • Repository: Project folder with complete history
  • Branch: Independent line of development
  • Commit: Snapshot of changes with message
  • Pull Request: Proposal to merge changes with review
  • Clone: Local copy of repository

Video Tutorials

Beginner

Advanced

Documentation

Most Used Commands

git status                    # See what changed
git diff                      # View detailed changes
git checkout -b branch-name   # Create new branch
git add file.md               # Stage changes
git commit -m "message"       # Commit changes
git push                      # Upload to GitHub
gh pr create                  # Create pull request
gh pr list                    # List open PRs
gh pr review <number>         # Review a PR

Key GitHub Shortcuts

Press ? on any GitHub page to see all shortcuts. Most useful:

  • t - File finder
  • w - Switch branches
  • . - Open web editor
  • e - Edit file

First Time Setup

# Configure Git identity
git config --global user.name "Your Name"
git config --global user.email "your.email@company.com"
git config --global init.defaultBranch main

# Setup SSH key (optional but recommended)
ssh-keygen -t ed25519 -C "your.email@company.com"
# Add key to GitHub: Settings > SSH and GPG keys

Review Best Practices

  • Be specific and constructive in comments
  • One topic per pull request
  • Reference issues with #issue-number
  • Keep PRs small and focused
  • Use markdown formatting for clarity
  • Respond to feedback within 24-48 hours

For complete details, installation instructions, and platform-specific guidance, see the full guide.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors