You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@storm.apache.org by bo...@apache.org on 2014/06/12 21:55:08 UTC
[11/13] git commit: add Clojure style links to DEVELOPER.md
add Clojure style links to DEVELOPER.md
Project: http://git-wip-us.apache.org/repos/asf/incubator-storm/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-storm/commit/2456f0aa
Tree: http://git-wip-us.apache.org/repos/asf/incubator-storm/tree/2456f0aa
Diff: http://git-wip-us.apache.org/repos/asf/incubator-storm/diff/2456f0aa
Branch: refs/heads/master
Commit: 2456f0aa8c3834ab562f32d645e2835402075ff2
Parents: 55e1664
Author: David James <da...@bluemontlabs.com>
Authored: Mon Jun 9 21:07:06 2014 -0700
Committer: David James <da...@bluemontlabs.com>
Committed: Mon Jun 9 21:08:02 2014 -0700
----------------------------------------------------------------------
DEVELOPER.md | 8 ++++++++
1 file changed, 8 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-storm/blob/2456f0aa/DEVELOPER.md
----------------------------------------------------------------------
diff --git a/DEVELOPER.md b/DEVELOPER.md
index 0c8de00..7d1c09c 100644
--- a/DEVELOPER.md
+++ b/DEVELOPER.md
@@ -92,6 +92,14 @@ and
[trivial issues](https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+STORM+AND+resolution+%3D+Unresolved+AND+priority+%3D+Trivial+ORDER+BY+key+DESC&mode=hide))
because they require learning about only an isolated portion of the codebase and are a relatively small amount of work.
+Please use idiomatic Clojure style, as explained in [this Clojure style guide][clj-SG]. Another useful reference is
+the [Clojure Library Coding Standards][clj-LCS]. Perhaps the most important is consistenly writing a clear docstring
+for functions, explaining the return value and arguments. As of this writing, the Storm codebase would benefit from
+various style improvements.
+
+[clj-SG]: https://github.com/bbatsov/clojure-style-guide
+[clj-LCS]: http://dev.clojure.org/display/community/Library+Coding+Standards
+
Contributions to the Storm codebase should be sent as GitHub pull requests. See section _Create a pull request_ below
for details. If there is any problem with the pull request we can iterate on it using the commenting features of
GitHub.