Skip to content

Commit f3954e1

Browse files
Merge pull request #555 from spacewander/contributing
Add Contributing guideline
2 parents 5bceec4 + d38d3f4 commit f3954e1

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Your new git-extra command should support
2+
3+
* OSX, Linux, BSD (You may need to browse their man page)<sup>*</sup>
4+
* Bash 3.2+ (If you aren't sure, see [the Bash changelog](http://tldp.org/LDP/abs/html/bash2.html))
5+
* Git 2.1+
6+
7+
<sup>*</sup>If you aren't able to test your new command on a platform,
8+
make that clear in your PR and someone else may be able to test it on their system.
9+
10+
## To submit a new command, you should
11+
12+
Let's assume your new command is named `foo`.
13+
14+
1. Write a bash script under `./bin` called `git-foo`.
15+
2. Read `./man/Readme.md` and write documentation for `git-foo`.
16+
3. Don't forget to introduce it in `Commands.md`.
17+
4. Update `./etc/git-extras-completion.zsh`. Just follow existing code.
18+
5. (Optional) Update `./etc/bash_completion.sh`.
19+
6. Run `./check_integrity.sh foo` to check if all done.
20+
21+
You are welcome to open up an issue to discuss new commands or features before opening a pull request.

0 commit comments

Comments
 (0)