Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
67 lines (40 sloc) 3.56 KB

Thank you!

Before anything else, thank you. We are honored that you're even considering contributing to DataCleaner.

This guide will help you get started with DataCleaner's development environment. You'll also find the set of rules you're expected to follow in order to submit improvements and fixes.

Where to find issues?

Our issue list is avialable on GitHub: DataCleaner issues. It's non-exhaustive and anyone is invited to post their own wishes and requirements as issues.

We use the issue tracker as the primary tool for discussing features. Otherwise it is requested you post a detailed comment for questions on possible issues. Be as descriptive as possible to allow reproducing your experience.

Build the code

Fork and clone the repository:

> git clone https://github.com/datacleaner/DataCleaner.git DataCleaner

Try your first build:

> cd DataCleaner
> mvn clean install

Report issues and ideas

Please use our issue list to report issues and ideas that you might work on. This is a great way to bounce ideas and get input to your contributions.

Submitting your patch

When submitting your patch, keep in mind that it should be easy for others to review. Therefore consider:

  • Don't change spaces to tabs or stuff like that. Clean up your patch so that it is readable.
  • We prefer you to post your patch as a GitHub Pull Request, and if possible please mention any relevant issue numbers in the Pull Request description.
  • If a Pull Request is NOT possible for whatever reason, use "git diff" to make a .diff file and post it as a Gist or something else, and add a comment with a link to the diff on the relevant issue.

About tests

Your patches receive extra points if there's a good set of unittests with it. If you're contributing a core utility/service/function then it is a requirement.

That said, especially the UI aspects (Swing or web frontend) are generally accepted as "not always feasible to test".

By default the build will include all self-contained tests, including some quick integration tests.

Coding guidelines

If you plan on submitting code, read this carefully. Please note it is not yet complete.

Our code style looks a lot like any other Java coding guidelines. Distinctive choices though:

  • We format indentation using spaces, not tabs. We use 4 spaces for each indentation.
  • We often prefix instance variables with an underscore (_). This to easily distinguish between method local and instance variables, as well as avoiding the overuse of the 'this' keyword in e.g. setter methods.
  • We format line wrapping using a desired max line length of 120 characters.
  • When possible, we tend to like the "final" keyword. This makes for more robust code and immutability is especially important in batch processing applications like DataCleaner.

Acceptance of changes

A few general rules of thumb:

  • Only DataCleaner admins and committers can merge Pull Requests.
  • We generally allow for up to 24 hours to pass before merging Pull Requests. This allows for anyone regardless of time zone to participate in the evaluation of the change.
  • We highly encourage actual review of the changes, but admins and committers can merge their own Pull Requests under the "Lazy Concensus" rule: After 24 hours without any activity on the Pull Request, it's allowed to self-merge it.
  • Only under trivial cases (such as changing build file or README updates) may admins push directly to the master branch.