How to contribute to Nuxeo

How to contribute to Nuxeo

Contributions

We are working on reorganizing the nuxeo.org site and we hope to make contribution easier.

Until then, you may still contribute to the Nuxeo EP project :

Translations

You must get nuxeo-platform-lang (french and english) and nuxeo-platform-lang-ext (all other languages).

From here, you can use any stardard java i18n tool and submit you additionnal file (or patch) via a Jira NXP ticket.

Please send a mail on the mailing list (nuxeo-dev) too.

Documentation

You can ask us for a contributor access on nuxeo.org (will be easier soon).

Java Patch

If you found a bug you corrected and modified some nuxeo code to add some feature, you can submit it via a Jira NXP ticket. Please try to also submit unit tests associated to the patch.

Please send a mail on the mailing list too.

New Modules

Ideally you should contact us via the mailing list when starting developing a new module you would like to contribute : we may have advices or existing code to provide.

When done you can submit the code via a Jira NXP ticket (code + tests + small description).

Please send a mail on the mailing list too.

Rules for contributing code

Coding Rules

You must try to comply to the coding rules explained in Nuxeo Book.

At least, please :

• use english is your comments and variables names
• provide unit tests
• avoid putting all logic in the Seam layer (create a Nuxeo Service for that)
• use Nuxeo Extension point system when applicable

Provide clean packaging

• align your code on a recent released version or on the trunk
• provide a clean pom (well indented, no duplication, etc.)
• if needed, provide a list of the artifacts (libs) that should be added to the Nuxeo Maven repository to be able to build
• avoid embedded libraries
• avoid introducing new libraries if the equivalent already exist in Nuxeo