Skip to content

Latest commit

 

History

History
31 lines (27 loc) · 1.81 KB

git.md

File metadata and controls

31 lines (27 loc) · 1.81 KB
Raw

Total GitHub Beginners Start here:

Downloads and Guides:

  1. Create a GitHub account
  2. Download Git Bash
  3. Use the git Documentation
  4. Work through: GitHub Guides
  5. This one is important: Understanding the GitHub Workflow

Conventions:

  1. Git Style Guide
  2. Leave exactly one empty line at the end of every file.
  3. Folder names are all small caps, spaces are done with dashes -
  4. Commit messages are small caps, starting with English present tense verbs e.g. add
  5. Run a spell checker/linter before you commit

Contribute to a project:

Read the README.md on the project and it should specify whether to (or both):

  1. Fork
  2. Clone

Every time you want to make a local change and push it to the remote repository:

  1. Pull or Fetch
  2. Resolve conflicts, if any
  3. Switch to the appropriate branch
  4. Add/edit, save <--- these are all local changes
  5. Stage
  6. Commit - add commit message
  7. Push
  8. Open Pull Request
  9. Make requested changes, save, stage, commit, push -> repeat until there are no more change requests from the maintainers. Important: there's NO need to open new pull requests as you push your updates. The whole PR workflow is centered around this idea that new commits you push will be added to the same open PR until it is ready to be merged in to the main project.