CONTRIBUTING.md 2.48 KB
Newer Older
cdanger's avatar
cdanger committed
1
## Contributing
Cyril Dangerville's avatar
Cyril Dangerville committed
2 3 4 5 6 7
### Coding Rules
Follow these Java coding guidelines:
* [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html), except braces must follow the Allman style instead of K & R style;
* *Effective Java, Second Edition*, by Joshua Bloch;
* [Oracle Secure Coding Guidelines for Java SE](http://www.oracle.com/technetwork/java/seccodeguide-139067.html).

Cyril Dangerville's avatar
Cyril Dangerville committed
8 9 10
### Testing
For every new major functionality, there must be unit tests added to some unit test class that is part of the automated test suite of [pdp-engine's MainTest.java](pdp-engine/src/test/java/org/ow2/authzforce/core/pdp/impl/test/MainTest.java). If the functionality has any impact on XACML - any Request/Response/Policy(Set) element - processing and/or change XACML standard conformance in anyway, make sure you add relevant integration and/or conformance tests to the test suite run by [pdp-testutils's MainTest.java](pdp-testutils/src/test/java/org/ow2/authzforce/core/pdp/testutil/test/MainTest.java).

Cyril Dangerville's avatar
Cyril Dangerville committed
11 12 13 14 15 16 17 18 19 20 21 22
You may run the tests as follows from your local copy of the repository:
<pre><code>
    $ mvn test
</code></pre>

### Building the project

You may build the project and generate the JAR as follows from your local copy of the repository:
<pre><code>
    $ mvn package
</code></pre>

23 24
Note that you must use Java 8 to run Maven when building the project.

Cyril Dangerville's avatar
Cyril Dangerville committed
25
### Dependency management
cdanger's avatar
cdanger committed
26 27
1. No SNAPSHOT dependencies on "develop" and obviously "master" branches

cdanger's avatar
cdanger committed
28 29 30
### Releasing
1. From the develop branch, prepare a release (example using a HTTP proxy):
<pre><code>
31
    $ mvn -Dhttps.proxyHost=proxyhostname -Dhttps.proxyPort=80 jgitflow:release-start
cdanger's avatar
cdanger committed
32 33 34 35
</code></pre>
1. Update the CHANGELOG according to keepachangelog.com.
1. To perform the release (example using a HTTP proxy):
<pre><code>
36
    $ mvn -Dhttps.proxyHost=proxyhostname -Dhttps.proxyPort=80 jgitflow:release-finish
cdanger's avatar
cdanger committed
37 38 39
</code></pre>
    If, after deployment, the command does not succeed because of some issue with the branches. Fix the issue, then re-run the same command but with 'noDeploy' option set to true to avoid re-deployment:
<pre><code>
40
    $ mvn -Dhttps.proxyHost=proxyhostname -Dhttps.proxyPort=80 -DnoDeploy=true jgitflow:release-finish
cdanger's avatar
cdanger committed
41 42 43 44
</code></pre>
1. Connect and log in to the OSS Nexus Repository Manager: https://oss.sonatype.org/
1. Go to Staging Profiles and select the pending repository authzforce-*... you just uploaded with `jgitflow:release-finish`
1. Click the Release button to release to Maven Central.
cdanger's avatar
cdanger committed
45 46

More info on jgitflow: http://jgitflow.bitbucket.org/