-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #555 from spacewander/contributing
Add Contributing guideline
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## Your new git-extra command should support | ||
|
||
* OSX, Linux, BSD (You may need to browse their man page)<sup>*</sup> | ||
* Bash 3.2+ (If you aren't sure, see [the Bash changelog](http://tldp.org/LDP/abs/html/bash2.html)) | ||
* Git 2.1+ | ||
|
||
<sup>*</sup>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`. | ||
|
||
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 done. | ||
|
||
You are welcome to open up an issue to discuss new commands or features before opening a pull request. |