xinb
/
zsh-completions
mirror of https://github.com/zsh-users/zsh-completions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#591: move CONTRIBUTING to root directory, README cleanup

This commit is contained in:
Julien Nicoulaud 2018-10-13 22:52:19 +02:00
parent 09ab969e20
commit 2a1350a60d
No known key found for this signature in database
GPG Key ID: D713C40AA20BF77D
2 changed files with 3 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
.github/CONTRIBUTING.md → CONTRIBUTING.md
View File

20
README.md
View File

@ -6,11 +6,6 @@ zsh-completions ![GitHub release](https://img.shields.io/github/release/zsh-user
*This projects aims at gathering/developing new completion scripts that are not available in Zsh yet. The scripts may be contributed to the Zsh project when stable enough.* *This projects aims at gathering/developing new completion scripts that are not available in Zsh yet. The scripts may be contributed to the Zsh project when stable enough.*
## Status
See [issues](https://github.com/zsh-users/zsh-completions/issues) for details on each completion definition.
## Usage ## Usage
### Using packages ### Using packages
@ -59,18 +54,9 @@ Add `antigen bundle zsh-users/zsh-completions` to your `~/.zshrc`.
### Contributing ### Contributing
Contributions are welcome, just make sure you follow the guidelines: Contributions are welcome, see [CONTRIBUTING](https://github.com/zsh-users/zsh-completions/blob/master/CONTRIBUTING.md).
* Completions are not accepted when already available in zsh.
* Completions are not accepted when already available in their original project.
* Please do not just copy/paste someone else completion, ask before.
* Completions only partially implemented are not accepted.
* Please add a header containing authors, status and origin of the script and license header if you do not wish to use the Zsh license (example [here](src/_ack)).
* Please try to follow [Zsh completion style guide](https://github.com/zsh-users/zsh/blob/master/Etc/completion-style-guide).
* Please send one separate pull request per file.
* Send a pull request or ask for committer access.
## License ## License
Completions use the Zsh license, unless explicitely mentionned in the file header. Completions use the Zsh license, unless explicitly mentioned in the file header.
See [LICENSE](https://github.com/zsh-users/zsh-completions/blob/master/LICENSE) for more information. See [LICENSE](https://github.com/zsh-users/zsh-completions/blob/master/LICENSE) for more information.