Skip to content

Commit a198a35

Browse files
committed
Update contribution guidelines
1 parent 591c449 commit a198a35

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

Contributing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Contribution Guidelines
66

7-
- **To add a helper script:** Submit a pull request.
8-
- **To remove a script:** Open an issue to discuss the removal and optionally create a pull request.
7+
- **To add a helper script:** Submit a pull request. Please use `#!/usr/bin/env interpreter` instead of a direct path to the interpreter, this makes it easier for people to use more recent versions when the ones packaged with their OS (OS X, I'm looking at you) are stale.
8+
- **To remove a script:** All of the scripts here were either taken from blog posts or had an Open Source license. That said, if you wrote something included here and want it removed, either open an issue to discuss the removal or submit a pull request.
99

10-
Please include an entry in the credits section of README.md for any scripts in your PRs so authors get their work credited correctly. Please keep the credits in alphabetical order by script name.
10+
Please include an entry in the credits section of README.md for any scripts in your PRs so authors get their work credited correctly. Add a link to the source in the comments at the beginning of your script so people can find their other work, and please keep the credits in alphabetical order by script name.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
# git-extra-commands
1919

20-
A zsh plugin that packages some extra git helper scripts I've found. I only wrote a few of these scripts, and the ones I didn't each have whatever licensing is included in the file. This collection doesn't actually require zsh, but packaging as a ZSH plugin makes it more convenient for anyone using a ZSH framework to use this collection.
20+
A zsh plugin that packages some extra git helper scripts I've found. I only wrote a few of these scripts, and the ones I didn't each have whatever licensing is included in the file. This collection doesn't actually require zsh, but packaging as a ZSH plugin makes it more convenient for people using a ZSH framework to use this collection.
2121

2222
If you wrote one of these scripts and want it removed from this repository, please either make a PR or file an issue against the repo and I will remove it.
2323

@@ -46,7 +46,7 @@ If you're using [oh-my-zsh](github.com/robbyrussell/oh-my-zsh):
4646

4747
`git clone https://github.com/unixorn/git-extra-commands.git git-extra-commands`
4848

49-
3. Edit your `~/.zshrc` and add `git-extra-commands` – same as clone directory– to the list of plugins to enable:
49+
3. Edit your `~/.zshrc` and add `git-extra-commands` – same as clone directory – to the list of plugins to enable:
5050

5151
`plugins=( ... git-extra-commands )`
5252

@@ -133,4 +133,4 @@ git clone this repository, then add it to your `$PATH`. Nothing here actually re
133133

134134
## Contributing
135135

136-
Please include an entry in the credits section of README.md for any scripts in your PRs so authors get their work credited correctly.
136+
Please include an entry in the credits section of README.md for any scripts in your PRs so authors get their work credited correctly. Please use `#!/usr/bin/env interpreter` instead of a direct path to the interpreter, this makes it easier for people to use more recent versions when the ones packaged with their OS (OS X, I'm looking at you) are stale.

0 commit comments

Comments
 (0)