diff --git a/Contributing.md b/Contributing.md index d183f2e47..73338e833 100644 --- a/Contributing.md +++ b/Contributing.md @@ -7,4 +7,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 (macOS and CentOS, I'm looking at you) are stale. - **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. -Please include an entry in the credits section of `README.md`, and an entry in the `zstyle` (completion) section of `git-extra-commands.plugin.zsh`, 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. +For each script you add, 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 an entry in the `zstyle` (completion) section of `git-extra-commands.plugin.zsh`, so the script gets proper tab completion. +* 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. diff --git a/README.md b/README.md index 447eb488e..5c541b452 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ [![Issue Count](https://codeclimate.com/github/unixorn/git-extra-commands/badges/issue_count.svg)](https://codeclimate.com/github/unixorn/git-extra-commands) [![GitHub stars](https://img.shields.io/github/stars/unixorn/git-extra-commands.svg)](https://github.com/unixorn/git-extra-commands/stargazers) -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. +**git-extra-commands** is a ZSH plugin that packages some extra git helper scripts I've found. This collection (and the scripts that I wrote in it) is licensed with the Apache Version 2 license. + +Some of the scripts in this collection came from other sources and may have different licensing - if they do, their license information is included inline in the script source. This collection doesn't actually require ZSH, but packaging it as a ZSH plugin makes it more convenient for people using a ZSH framework to use this collection. @@ -190,7 +192,7 @@ Here are some helpful aliases for your `~/.gitconfig` * [gitready.com/](http://gitready.com/) is another great reference which has been collecting information and tips for git since 2009. * [gitimmersion.com/](http://gitimmersion.com/) -* There’s a quick [Introduction to git](http://learnxinyminutes.com/docs/git/) on learnxinyminutes.com +* There’s a quick [Introduction to git](https://learnxinyminutes.com/docs/git/) on [learnxinyminutes.com](https://learnxinyminutes.com) * There's a more detailed git tutorial on [learnenough.com](http://www.learnenough.com/git-tutorial)