|
|
@ -103,6 +103,35 @@ This project would not exist without all of its users and [contributors][9]. |
|
|
|
If you have ideas on how to make the configuration easier to maintain or |
|
|
|
If you have ideas on how to make the configuration easier to maintain or |
|
|
|
improve its performance, do not hesitate to fork and send pull requests. |
|
|
|
improve its performance, do not hesitate to fork and send pull requests. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Issue Reporting |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- Check that the issue has not already been reported. |
|
|
|
|
|
|
|
- Check that the issue has not already been fixed in the latest code. |
|
|
|
|
|
|
|
- Open an issue with a clear title and description in gramatically correct, |
|
|
|
|
|
|
|
complete sentences. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Pull Request |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- Read [how to properly contribute to open source projects on GitHub][10]. |
|
|
|
|
|
|
|
- Use a topic branch to easily amend a pull request later, if necessary. |
|
|
|
|
|
|
|
- Write [good commit messages][11]. |
|
|
|
|
|
|
|
- Squash commits on the topic branch before opening a pull request. |
|
|
|
|
|
|
|
- Use the same coding style and spacing. |
|
|
|
|
|
|
|
- Open a [pull request][12] that relates to but one subject with a clear |
|
|
|
|
|
|
|
title and description in gramatically correct, complete sentences. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Modules |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- A *README.md* must be present. |
|
|
|
|
|
|
|
- Large functions must be placed in a *functions* directory. |
|
|
|
|
|
|
|
- Functions that take arguments must have completion. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Themes |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- A screenshots section must be present in the file header. |
|
|
|
|
|
|
|
- The pull request description must have must have [embedded |
|
|
|
|
|
|
|
screenshots][13]. |
|
|
|
|
|
|
|
|
|
|
|
License |
|
|
|
License |
|
|
|
------- |
|
|
|
------- |
|
|
|
|
|
|
|
|
|
|
@ -137,4 +166,8 @@ SOFTWARE. |
|
|
|
[7]: https://github.com/zsh-users/zsh-completions |
|
|
|
[7]: https://github.com/zsh-users/zsh-completions |
|
|
|
[8]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf |
|
|
|
[8]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf |
|
|
|
[9]: https://github.com/sorin-ionescu/oh-my-zsh/contributors |
|
|
|
[9]: https://github.com/sorin-ionescu/oh-my-zsh/contributors |
|
|
|
|
|
|
|
[10]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request |
|
|
|
|
|
|
|
[11]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |
|
|
|
|
|
|
|
[12]: https://help.github.com/articles/using-pull-requests |
|
|
|
|
|
|
|
[13]: http://daringfireball.net/projects/markdown/syntax#img |
|
|
|
|
|
|
|
|
|
|
|