Skip to content

Commit

Permalink
Upgrade documentation for website
Browse files Browse the repository at this point in the history
  • Loading branch information
joelparkerhenderson committed Jan 11, 2022
1 parent 38f82c9 commit 72ab030
Show file tree
Hide file tree
Showing 355 changed files with 7,826 additions and 2,295 deletions.
28 changes: 26 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,30 @@ We welcome people contributing in many ways:
* Spread the word about us: http://gitalias.com


## Advice

Typically a short alias for a command and its options
should be in the same order as the command and option words:

* Right: `fab = foo --alpha --bravo`

* Wrong: `baf = foo --alpha --bravo`

Typically a short alias for a command and its options
should be using the first letter of each option word:

* Right: `fab = foo --alpha-bravo`

* Wrong: `fa = foo --alpha-bravo`

One-letter aliases never use options, because we want
the aliases to be as easy as possible to compose:

* Right: `s = status`

* Wrong: `s = status --alpha --bravo`


## Conventions

Conventions for coding:
Expand All @@ -36,11 +60,11 @@ We want this project to be good for teams:

Because we want widespread usability, we do not include everything possible:

* For example, we do not have a one-letter shortcut for `git push`
* For example, we do not have a one-letter short alias for `git push`
because we have not found a widespread consensus among developers.
We prefer using higher-level capabilities, such as a git hook that
watches for a commit, then does an automatic push to a CI/CD server.

* For example, we do not provide aliases for many kinds of git workflows
because our research finds that each team has it's own kind of workflow.
We provide a generic topic branch workflow that works well for many teams,
Expand Down
Loading

0 comments on commit 72ab030

Please sign in to comment.