Author: mibo
Date: Wed Dec 9 09:23:42 2015
New Revision: 1718782
URL: http://svn.apache.org/viewvc?rev=1718782&view=rev
Log:
Minor changes
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=1718782&r1=1718781&r2=1718782&view=diff
==============================================================================
--- olingo/site/trunk/content/contribute.mdtext (original)
+++ olingo/site/trunk/content/contribute.mdtext Wed Dec 9 09:23:42 2015
@@ -22,7 +22,7 @@ Notice: Licensed to the Apache Softwa
[TOC]
-###Overview###
+### 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 chapter.
@@ -33,38 +33,48 @@ The Olingo uses the following process fo
1. Clone the Olingo Project
2. Report a bug or feature
3. Develop the according bugfix / feature
- 4. Prepare your code for contribution
+ 4. Prepare your code for contribution
5. Submit your JIRA ticket to receive feedback
-### Report a bug or feature
+### Report a bug or feature
If have you found a bug, please provide a detailed explanation how the bug can
be reproduced.
You should mention the following properties:
- - Version of the library e.g. Olingo V4 (4.0.0)
+ - Version of the library e.g. `(Java) V4 4.0.0`
- 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 library the bug occurs.
(only if available)
+ - Append further information in which part of the library the bug occurs (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**
+**Bug/Feature Priorities**
The Olingo project uses the following definition of priorities:
- - Blocker - The bug must be fixed before the next release
- - Critical - The bug should be resolved immediately and must be fixed before
the next major release.
- - Major - This bug should be resolved as soon as possible in the normal
course of development activity, before the software is released.
- - Minor (**default**) - This bug should be repaired after serious bugs have
been fixed.
- - Trivial - It can be resolved in a future major system revision or not be
resolved at all.
+ - *Blocker* - This bug/feature must be fixed/implemented before the next
release
+ - *Critical* - This bug/feature should be resolved/implemented immediately
and must be fixed/implemented before the next major release.
+ - *Major* - This bug/feature should be resolved/implemented as soon as
possible in the normal course of development activity, before the software is
released.
+ - *Minor* (**default**) - This bug/feature should be fixed/implemented after
serious bugs have been fixed/implemented.
+ - *Trivial* - This bug/feature can be resolved in a future major system
revision or not be resolved/implemented at all.
The default priority is **Minor**.
+**Bug/Feature Types**
+The Olingo project uses the following *types* for an issue:
+
+ - *Feature* - An issue that introduced a new feature (behaviour) to the
Olingo library (this could be e.g. an additional not yet implemented part of
the OData specification or convenience methods)
+ - *Improvement* - An issue that improves an existing feature (behaviour) of
the Olingo library (this could be e.g. a convenience method or internal
improvements which does not change behavior)
+ - *Bug* - An issue that describes an incorrect behaviour of the Olingo
library in relation to the according OData specification.
+ - *Test* - An issue that only improve or exentds tests for the Olingo
library.
+ - *Task* - An issue that improve or exentds basic parts for the Olingo
library without changing code (or logic). This could be e.g. improvements or
changes necessary for the build infrastructure.
+ - *Question* - An issue that only is a question related to the Olingo
library.
+
### Develop the according bugfix / feature
#### Clone the Olingo Project
-The current development version can be found in the Apache git repository.
+The current development version can be found in the Apache git repository.
Please note Olingo provides two different libraries. One one hand Olingo V2
which implements the OData V2 specification and Olingo V4, which implements the
OData V4 specification.
To clone the current master branch of the Olingo project please use one of the
following commands:
@@ -83,15 +93,15 @@ To provide a bug fix, checkout the curre
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 documentation or tutorials you should write your contribution using
Markdown syntax.
+**Providing documentation for the Apache website**
+To provide documentation or tutorials you should write your contribution using
[a Markdown syntax](www.apache.org/dev/cmsref#markdown).
#### Prepare your code for contribution
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**
+**Example - Create a patch file**
You have done several commits and want to provide a single commit which
contains all your changes.
...
@@ -104,7 +114,7 @@ You have done several commits and want t
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**
+**Example - Appling a patch file**
You like to apply a patch file named "OLINGO_42.patch". Use the following
commands:
- git am --signoff OLINGO_42.patch
\ No newline at end of file
+ git am --signoff OLINGO_42.patch
