-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
resolves #16 - Create support doc for common commands
- Loading branch information
Showing
1 changed file
with
168 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| # EthBuilders Curriculum Support | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| <!-- TOC --> | ||
|
|
||
| - [EthBuilders Curriculum Support](#ethbuilders-curriculum-support) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Project Contact Info](#project-contact-info) | ||
| - [Anthony A (Organizer | Developer)](#anthony-a-organizer--developer) | ||
| - [Edward Amor (Developer)](#edward-amor-developer) | ||
| - [Common Commands](#common-commands) | ||
| - [Git](#git) | ||
| - [Yarn | NPM](#yarn--npm) | ||
| - [General Resources and Links](#general-resources-and-links) | ||
| - [Git / Github](#git--github) | ||
|
|
||
| <!-- /TOC --> | ||
|
|
||
| ## Project Contact Info | ||
|
|
||
| [Join our Slack](http://bit.ly/NYC-Blockchain-Devs-Join-Slack) | ||
|
|
||
| ### Anthony A (Organizer | Developer) | ||
|
|
||
| - Github: [@tesla809](https://github.com/tesla809) | ||
| - Slack: `@Anthony_Albertorio_NEVER_ASKS_FOR_COIN ` | ||
|
|
||
| ### Edward Amor (Developer) | ||
|
|
||
| - Github: [@skellet0r](https://github.com/skellet0r) | ||
| - Slack: `@Edward Amor` | ||
|
|
||
| ## Common Commands | ||
|
|
||
| ### Git | ||
|
|
||
| **Information** | ||
|
|
||
| - Show the working tree status | ||
| `git status` | ||
| - show the current HEAD and its ancestry | ||
| `git log` | ||
| - show the current HEAD and its ancestry with formatting | ||
| `git log --pretty=format:"%h %s" --graph` | ||
| - show an ordered list of the commits that HEAD has pointed to (a local undo history for your repo - [reference](https://stackoverflow.com/questions/17857723/whats-the-difference-between-git-reflog-and-log)) | ||
| `git reflog` | ||
| - show all branches | ||
| `git branch -a` | ||
| - list remote repositories | ||
| `git remote -v` | ||
| - show line-by-line changes in your branch compared to master | ||
| `git diff` | ||
|
|
||
| **Make Changes** | ||
|
|
||
| - Create new branch to make changes | ||
| `git checkout -b <branch>` | ||
| - Checkout branch to make changes | ||
| `git checkout <branch>` | ||
| - Change file name | ||
| `git mv <old-file> <new-file>` | ||
| - Delete file | ||
| `git rm <file>` | ||
|
|
||
| **Commit Changes** | ||
|
|
||
| - Make changes to the file | ||
| `atom <filename>` _(or text editor of your choice)_ | ||
| - Add a single file with changes | ||
| `git add <filename>` | ||
| - Add all files with changes | ||
| `git add -A` | ||
| - Commit the change with a message | ||
| `git commit -m "Commit Message"` | ||
| See [CONTRIBUTING.MD](../CONTRIBUTING.MD) for style guide on how to format commits. | ||
| - Add all files and commit the change in one command | ||
| `git commit -am "Commit Message"` | ||
| - Modify last commit message | ||
| `git commit --amend` | ||
| - Push change to repository (on Github) | ||
| `git push origin` | ||
|
|
||
| **Update the Repo** | ||
|
|
||
| - Setting an upstream repository | ||
| `git remote add upstream <clone-link>` | ||
| - Check out the master branch | ||
| `git checkout master` | ||
| - Fetch branch from the upstream repository | ||
| `git fetch upstream <branch>` | ||
| - Rebase changes from the upstream repository | ||
| `git rebase upstream/<branch>` | ||
| - Push changes to the origin repository | ||
| `git push origin` | ||
|
|
||
| **Delete Branch** | ||
|
|
||
| - Delete the branch from origin | ||
| `git push origin -d <branch>` | ||
| - Delete the branch from local | ||
| `git branch -d <branch>` | ||
|
|
||
| ### Yarn | NPM | ||
|
|
||
| [Full list of yarn commands](https://classic.yarnpkg.com/en/docs/cli/) | ||
| [Full list of npm commands](https://docs.npmjs.com/cli/v6/commands) | ||
|
|
||
| `yarn install` \ | ||
| `npm i` | ||
|
|
||
| - Install all node modules | ||
| - [Yarn - more info](https://classic.yarnpkg.com/en/docs/cli/install) | ||
| - [npm - more info](https://docs.npmjs.com/cli/v6/commands/npm-install) | ||
|
|
||
| `yarn add <package-name>` \ | ||
| `npm install <package-name>` | ||
|
|
||
| - Installs a package and any packages that it depends on | ||
| - [Yarn - more info](https://classic.yarnpkg.com/en/docs/cli/add) | ||
| - [npm - more info](https://docs.npmjs.com/cli/v6/commands/npm-install) | ||
|
|
||
| `yarn remove <package-name>` \ | ||
| `npm uninstall <package-name>` | ||
|
|
||
| - Removes an unused package from your current package.json | ||
| - [Yarn - more info](https://classic.yarnpkg.com/en/docs/cli/remove) | ||
| - [npm - more info](https://docs.npmjs.com/cli/v6/commands/npm-uninstall) | ||
|
|
||
| `yarn init` \ | ||
| `npm init` | ||
|
|
||
| - Initializes the development of a package. | ||
| - [Yarn - more info](https://classic.yarnpkg.com/en/docs/cli/init) | ||
| - [npm - more info](https://docs.npmjs.com/cli/v6/commands/npm-init) | ||
|
|
||
| `yarn upgrade <package-name>@<verision>` \ | ||
| `npm update <package-name>@<verision>` | ||
|
|
||
| - Upgrades packages to their latest version based on the specified range | ||
| - [Yarn - more info](https://classic.yarnpkg.com/en/docs/cli/upgrade) | ||
| - [npm - more info](https://docs.npmjs.com/cli/v6/commands/npm-update) | ||
|
|
||
| ## General Resources and Links | ||
|
|
||
| ### Git / Github | ||
|
|
||
| **Git Resources** | ||
|
|
||
| - Git Offical Docs: [Git Command Reference](https://git-scm.com/doc) | ||
| - Git Tower: [Learn Version Control with Git](https://www.git-tower.com/learn/git/ebook/en/command-line/introduction) | ||
| - Git Tower: [What is a rebase in Git?](https://www.git-tower.com/learn/git/glossary/rebase) | ||
| - Git Tower: [`rebase` as an alternative to `merge`](https://www.git-tower.com/learn/git/ebook/en/desktop-gui/advanced-topics/rebase#start) | ||
| - Atlassian: [Overview of `rebase`](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase) | ||
| - Github Help: [How to use `rebase`](https://help.github.com/en/github/using-git/using-git-rebase-on-the-command-line) | ||
| - [Learning Git Branching](https://learngitbranching.js.org/?locale=en_US) | ||
| - [A successful Git branching model](https://nvie.com/posts/a-successful-git-branching-model/) | ||
| - [Oh Shit, Git!?!](https://ohshitgit.com/) with real problems and solutions | ||
|
|
||
| > ⚠️ 👀 **WARNING:** | ||
| > You should use rebase only for squashing YOUR local commits prior to a pull request. DO NOT ever rebase commits that have already been published to master. This will rewrite our public project's history. This applies to maintainers of the project. | ||
| **Github Workflow Resources** | ||
|
|
||
| - Github Guides: [Understanding the GitHub flow](https://guides.github.com/introduction/flow/) | ||
| - [GitHub Standard Fork & Pull Request Workflow (Chaser324)](https://gist.github.com/Chaser324/ce0505fbed06b947d962) | ||
| - Digital Ocean: [How To Create a Pull Request on GitHub](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) | ||
| - Mozilla Servo: [Beginner's guide to rebasing and squashing](https://github.com/servo/servo/wiki/Beginner's-guide-to-rebasing-and-squashing) |