Skip to content

Commit abc4bc1

Browse files
Upgrade documentation for website
1 parent 38f82c9 commit abc4bc1

File tree

328 files changed

+6668
-1621
lines changed

Some content is hidden

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

328 files changed

+6668
-1621
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 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:

0 commit comments

Comments
 (0)