Skip to content
Browse files

[Fix #293] Add CONTRIBUTING.md

  • Loading branch information...
1 parent 7d68d3f commit 2037e693e8aae6767b92599ed827acfda1c9b521 Sorin Ionescu committed Sep 25, 2012
Showing with 42 additions and 42 deletions.
  1. +42 −0 CONTRIBUTING.md
  2. +0 −42 README.md
View
42 CONTRIBUTING.md
@@ -0,0 +1,42 @@
+Contributing
+------------
+
+This project would not exist without all of its users and [contributors][1].
+
+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.
+
+### 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 grammatically correct,
+ complete sentences.
+
+### Pull Request
+
+ - Read [how to properly contribute to open source projects on GitHub][2].
+ - Use a topic branch to easily amend a pull request later, if necessary.
+ - Write [good commit messages][3].
+ - Squash commits on the topic branch before opening a pull request.
+ - Use the same coding style and spacing.
+ - Open a [pull request][4] that relates to but one subject with a clear
+ title and description in grammatically 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 [embedded screenshots][5].
+
+[1]: https://github.com/sorin-ionescu/prezto/contributors
+[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[4]: https://help.github.com/articles/using-pull-requests
+[5]: http://daringfireball.net/projects/markdown/syntax#img
+
View
42 README.md
@@ -91,43 +91,6 @@ Resources
The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.
-Contribute
-----------
-
-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
-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 grammatically 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 grammatically 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 [embedded
- screenshots][13].
-
License
-------
@@ -161,9 +124,4 @@ SOFTWARE.
[6]: http://gitref.org
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
[8]: http://grml.org/zsh/zsh-lovers.html
-[9]: https://github.com/sorin-ionescu/prezto/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

0 comments on commit 2037e69

Please sign in to comment.
Something went wrong with that request. Please try again.