utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-10 23:46:24 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add contributing guideline

Browse source
This commit is contained in:
spacewander 2016-07-25 23:02:12 +08:00
parent 0c8abf8624
commit 3de481706d
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,16 @@
## Your new git-extra command should support...
* Should support Mac and Linux(You may need to browse their man page)
* Should support Bash 3 or newer(If you are not sure, [Bash versions](http://tldp.org/LDP/abs/html/bash2.html))
* Should support Git 2.1+
## To submit a new command, you should...
Let's assume your new command is named `foo`.
1. Write a bash script under `./bin` called `git-foo`.
2. Read `./man/Readme.md` and write documentation for `git-foo`.
3. Don't forget to introduce it in `Commands.md`.
4. Update `./etc/git-extras-completion.zsh`. Just follow existing code.
5. (Optional) Update `./etc/bash_completion.sh`.
6. Run `./check_integrity.sh foo` to check if all is done.