Author: wangwei
Date: Mon May 18 06:36:02 2015
New Revision: 1679945
URL: http://svn.apache.org/r1679945
Log:
add code contribution page
Modified:
incubator/singa/site/trunk/content/markdown/community/contribute-code.md
Modified:
incubator/singa/site/trunk/content/markdown/community/contribute-code.md
URL:
http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/community/contribute-code.md?rev=1679945&r1=1679944&r2=1679945&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/community/contribute-code.md
(original)
+++ incubator/singa/site/trunk/content/markdown/community/contribute-code.md
Mon May 18 06:36:02 2015
@@ -0,0 +1,39 @@
+Like other Apache projects, SINGA uses JIRA to track bugs, improvements and
+other high-level discussions (e.g., system design and features). Github pull
requests are
+used for implementation discussions, e.g., code review and code merge.
+
+### JIRA format
+
+* Provide a descriptive Title.
+* Write a detailed Description. For bug reports, this should ideally include a
+ short reproduction of the problem. For new features, it may include a design
+ document.
+* Set [required
fields](https://cwiki.apache.org/confluence/display/SPARK/Contributing+to+Spark#ContributingtoSpark-JIRA)
+
+### Pull Request
+
+The work flow is
+
+* Fork the [SINGA Github
repository](https://github.com/apache/incubator-singa) to
+your own Github account.
+
+* Clone your fork, create a new branch (e.g., feature-foo or fixbug-foo),
+ work on it. After finishing your job,
+ [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) it to the
+ current latest master and push commits to your own Github account (the new
+ branch).
+
+* Open a pull request against the master branch of apache/incubator-singa.
+The PR title should be of the form [SINGA-xxxx] Title, where
+SINGA-xxxx is the relevant JIRA number, and Title may be the JIRA's title or a
+more specific title describing the PR itself. The link to the JIRA should be
+provided. Detailed description can be copied from the JIRA.
+Consider identifying committers or other contributors who have worked on the
+code being changed. Find the file(s) in Github and click "Blame" to see a
+line-by-line annotation of who changed the code last. You can add @username in
+the PR description to ping them immediately.
+Please state that the contribution is your original work and that you license
+the work to the project under the project's open source license.
+
+* Wait for one committer to review the patch. Further commits (e.g., bug fix)
+to your new branch will be added to this pull request automatically by Github.
\ No newline at end of file
