From 3de481706d463c84f2bd19470b779da05f06af97 Mon Sep 17 00:00:00 2001 From: spacewander Date: Mon, 25 Jul 2016 23:02:12 +0800 Subject: [PATCH 1/3] 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. From 311ef28b66b2b5f98609eb993e9e51469d83b7ed Mon Sep 17 00:00:00 2001 From: spacewander Date: Fri, 29 Jul 2016 11:33:55 +0800 Subject: [PATCH 2/3] modify CONTRIBUTING.md --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81e0008..44336cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,10 @@ -## Your new git-extra command should support... +## 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+ +* OSX, Ubuntu, FreeBsd(You may need to browse their man page) +* Bash 3.2+ (If you are not sure, [Bash versions](http://tldp.org/LDP/abs/html/bash2.html)) +* Git 2.1+ -## To submit a new command, you should... +## To submit a new command, you should Let's assume your new command is named `foo`. @@ -14,3 +14,5 @@ Let's assume your new command is named `foo`. 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. + +You are welcome to open up an issue to discuss new commands or features before opening a pull request. From d38d3f4ffa88074f228509dce754d0b438afafca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=BD=97=E6=B3=BD=E8=BD=A9?= Date: Sat, 30 Jul 2016 22:49:06 +0800 Subject: [PATCH 3/3] modify CONTRIBUTING.md again --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44336cd..af100e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,12 @@ ## Your new git-extra command should support -* OSX, Ubuntu, FreeBsd(You may need to browse their man page) -* Bash 3.2+ (If you are not sure, [Bash versions](http://tldp.org/LDP/abs/html/bash2.html)) +* OSX, Linux, BSD (You may need to browse their man page)* +* Bash 3.2+ (If you aren't sure, see [the Bash changelog](http://tldp.org/LDP/abs/html/bash2.html)) * Git 2.1+ +*If you aren't able to test your new command on a platform, +make that clear in your PR and someone else may be able to test it on their system. + ## To submit a new command, you should Let's assume your new command is named `foo`. @@ -13,6 +16,6 @@ Let's assume your new command is named `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. +6. Run `./check_integrity.sh foo` to check if all done. You are welcome to open up an issue to discuss new commands or features before opening a pull request.