Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
dmak committed May 31, 2017
1 parent 6271fd8 commit a5305aa
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -524,8 +524,8 @@ The original code of Bjarne Hansen, with some fixes.
If you have time and desire to contribute to this project you can do it in many ways:

* Improve this very documentation.
* Implement Unit tests.
* Provide more samples.
* Implement unit tests.
* Provide extra samples.

### Development

Expand All @@ -539,11 +539,16 @@ Everybody is very welcomed to send patches by email. But the best way would be:
- Verify your outgoing changeset. Make sure that:
- your changeset is _minimal and sufficient_ for the feature implementation
- your formatting rules have not caused changes in each and every line (e.g. due to end-of-line markers)
- unit tests run successfully
- Commit to your own fork, mentioning the ticket number in commit message (`Implemented nice feature (fixes #22)`). Check [here](https://github.com/blog/831-issues-2-0-the-next-generation) the commit message syntax sugar.
- [Request for pull](http://help.github.com/send-pull-requests/).

If you provide the code in any way (patch, pull request, post, comment, …) you automatically agree with a [project license](#license).

### Bug reports

This very open source project is maintained and improved during my free time. That is why I have no ability to test the functionality will all different combinations of Java, JAXB, JAXB plugins and Maven plugins. I leave this to community. Also newly created bug report should mention Java version and have a simple project attached (or one can clone the repository and alter one of the [`samples`](samples/)) that demonstrates the problem.

#### Code style

* There are no specific coding and naming conventions for this project except ones given in [Code Conventions for the Java Programming Language](http://www.oracle.com/technetwork/java/codeconv-138413.html) by Sun. Use best practices and common sense.
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

<ciManagement>
<system>Jenkins</system>
<url>https://dmak.ci.cloudbees.com/job/jaxb-xew-plugin/</url>
<url>https://travis-ci.org/dmak/jaxb-xew-plugin</url>
</ciManagement>

<licenses>
Expand Down

0 comments on commit a5305aa

Please sign in to comment.