Author: chrish
Date: Tue Dec 8 13:27:28 2015
New Revision: 1718592
URL: http://svn.apache.org/viewvc?rev=1718592&view=rev
Log:
CMS commit to olingo by chrish
Modified:
olingo/site/trunk/content/contribute.mdtext
Modified: olingo/site/trunk/content/contribute.mdtext
URL:
http://svn.apache.org/viewvc/olingo/site/trunk/content/contribute.mdtext?rev=1718592&r1=1718591&r2=1718592&view=diff
==============================================================================
--- olingo/site/trunk/content/contribute.mdtext (original)
+++ olingo/site/trunk/content/contribute.mdtext Tue Dec 8 13:27:28 2015
@@ -20,21 +20,22 @@ Notice: Licensed to the Apache Softwa
###Overview###
-If you want to contribute to the Olingo Project, you can submit patches,
report bugs or provide documentation and tutorials. Contributions are managed
in the project [JIRA](https://issues.apache.org/jira/browse/OLINGO). So if you
found a bug or want to provide a contribution please open a new
[JIRA](https://issues.apache.org/jira/browse/OLINGO) ticket. Detailed
information how to contribute can be found in the following capter.
+If you want to contribute to the Olingo Project, you can submit patches,
report bugs or provide documentation and tutorials. Contributions are managed
in the project [JIRA](https://issues.apache.org/jira/browse/OLINGO). So if you
found a bug or want to provide a contribution please open a new
[JIRA](https://issues.apache.org/jira/browse/OLINGO) ticket. Detailed
information how to contribute can be found in the following chapter.
### Contribute via Git-Patch/Pull-Request and Olingo-JIRA
-The Olingo uses the following process for contributins:
-1. Reporting a bug or feature
-2. Develop the according bugfix / feature
-3. Prepare your code for contribtion
-4. Submit your JIRA ticket to receive feedback
+The Olingo uses the following process for contributions:
+
+ 2. Report a bug or feature
+ 3. Develop the according bugfix / feature
+ 4. Prepare your code for contribution
+ 5. Submit your JIRA ticket to receive feedback
### Clone the Olingo Project
The current development version can be found in the Apache git repository.
Please note that there are two different repositories, one for Version 2 and
one for Version 4 of the OData protocol.
-To clone the current master branch of the Olingo project please use one of the
folling commands:
+To clone the current master branch of the Olingo project please use one of the
following commands:
**OData V2 Code**
@@ -49,16 +50,16 @@ To clone the current master branch of th
**Reporting a bug**
-If you found a bug, please provide a detailed explaination how the bug can be
reproduced.
+If you found a bug, please provide a detailed explanation how the bug can be
reproduced.
-You should meation the following properties:
- * Version of the libray e.g. Olingo V4 (4.0.0-beta-03)
- * If a part of the implementation is not compliant to the OData protocol,
please link the the related part of the spefication or provide a link to the
related JIRA issue of OData protcoll. The offical OASIS-OData JIRA can be found
[here](https://issues.oasis-open.org/browse/ODATA/)
- * Often bugs are related to the underlaying metadata document. Please
append the related part of the metadata document to reproduce the bug.
- * Provide a code snipped to reproducte the bug.
+You should mention the following properties:
+ * Version of the library e.g. Olingo V4 (4.0.0-beta-03)
+ * If a part of the implementation is not compliant to the OData protocol,
please link the related part of the speciation or provide a link to the related
JIRA issue of OData protocol. The official OASIS-OData JIRA can be found
[here](https://issues.oasis-open.org/browse/ODATA/)
+ * Often bugs are related to the underlying metadata document. Please append
the related part of the metadata document to reproduce the bug.
+ * Provide a code snipped to reproduce the bug.
* If you receive an exception, provide the stack trace of the exception.
- * Append further information in which part of the libray the bug occurs.
(only if available)
- * If you have fixed a bug, you can append the solution to the request.
Further information how to sent your solution are provided in the following
chapters.
+ * Append further information in which part of the library the bug occurs.
(only if available)
+ * If you have fixed a bug, you can append the solution to the request.
Further information how to append your solution to a ticket are provided in the
following chapters.
**Bug Priorities**
The Olingo project uses the following definition of priorities:
@@ -73,12 +74,12 @@ The default priority is Minor.
### Develop the according bugfix / feature
**Providing code**
-To provide a bug fix, checkout the current master branch of the project and
develop your solution. In Olingo we truly belive in tests, so your contribution
should at least contain tests that show that your contribution works as
expected and also tests that reproductes the previous reported bug. If you
provide a new feature your tests should reach at least 80 percent test-coverage.
+To provide a bug fix, checkout the current master branch of the project and
develop your solution. In Olingo we truly believe in tests, so your
contribution should at least contain tests that show that your contribution
works as expected and also tests that reproduces the previous reported bug. If
you provide a new feature your tests should reach at least 80 percent
test-coverage.
To append your contribution to a JIRA ticket, please create a patch file as
explained in the chapter.
**Providing documentation for the Apache website**
-To provide documentaion or tutorials you should write your contribution using
Markdown syntax.
+To provide documentation or tutorials you should write your contribution using
Markdown syntax.
### Prepare your code for contribution
@@ -86,7 +87,7 @@ To provide documentaion or tutorials you
To append you contribution to a JIRA issue, please create a [patch
file](https://git-scm.com/docs/git-format-patch). The commit message should
contain the JIRA request number (e.g. OLINGO-42) and a short commit message.
**Example - Create a patch file**
-You have done serval commits and want to provide a single commit which
contains all your changes.
+You have done several commits and want to provide a single commit which
contains all your changes.
...
git commit -m "[OLINGO-42] Start development new feature"
@@ -96,11 +97,10 @@ You have done serval commits and want to
git rebase -i HEAD~3
git format-patch -1
-First rebase your local history to create a single commit. Afer that create a
patch file using git format-patch. Now you can upload and append your created
patch file to the JIRA issue.
+First rebase your local history to create a single commit. After that create a
patch file using git format-patch. Now you can upload and append your created
patch file to the JIRA issue.
**Example - Appling a patch file**
You like to apply a patch file named "OLINGO_42.patch". Use the following
commands:
git am --signoff 0001-Test.patch
-
