From 3de481706d463c84f2bd19470b779da05f06af97 Mon Sep 17 00:00:00 2001 From: spacewander Date: Mon, 25 Jul 2016 23:02:12 +0800 Subject: [PATCH] Add contributing guideline --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..81e0008 --- /dev/null +++ b/CONTRIBUTING.md @@ -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.