Skip to content

Commit 72ab030

Browse files
Upgrade documentation for website
1 parent 38f82c9 commit 72ab030

File tree

355 files changed

+7826
-2295
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

355 files changed

+7826
-2295
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,30 @@ We welcome people contributing in many ways:
1111
* Spread the word about us: http://gitalias.com
1212

1313

14+
## Advice
15+
16+
Typically a short alias for a command and its options
17+
should be in the same order as the command and option words:
18+
19+
* Right: `fab = foo --alpha --bravo`
20+
21+
* Wrong: `baf = foo --alpha --bravo`
22+
23+
Typically a short alias for a command and its options
24+
should be using the first letter of each option word:
25+
26+
* Right: `fab = foo --alpha-bravo`
27+
28+
* Wrong: `fa = foo --alpha-bravo`
29+
30+
One-letter aliases never use options, because we want
31+
the aliases to be as easy as possible to compose:
32+
33+
* Right: `s = status`
34+
35+
* Wrong: `s = status --alpha --bravo`
36+
37+
1438
## Conventions
1539

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

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

39-
* For example, we do not have a one-letter shortcut for `git push`
63+
* For example, we do not have a one-letter short alias for `git push`
4064
because we have not found a widespread consensus among developers.
4165
We prefer using higher-level capabilities, such as a git hook that
4266
watches for a commit, then does an automatic push to a CI/CD server.
43-
67+
4468
* For example, we do not provide aliases for many kinds of git workflows
4569
because our research finds that each team has it's own kind of workflow.
4670
We provide a generic topic branch workflow that works well for many teams,

0 commit comments

Comments
 (0)