Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated Code Style and Checkstyle links to reflect current location in project repository

...

[remote "github"]
url = git@github.com:apache/nifi.git
fetch = +refs/heads/*:refs/remotes/github/*
fetch = +refs/pull/*/head:refs/remotes/github/pr/*

Code Style

This is a developing standard and will be updated to reflect an agreed upon format further supported by the The maven-checkstyle-plugin.  Our current checkstyle rules can be found here.TODO: Provide code formatters for the common IDEs enforces minimum code style requirements.

The checkstyle.xml configuration in the project root directory contains the current set of style rules.

IntelliJ IDEA Users

nifi-checkstyle.xml is a Checkstyle configuration file created by extracting checkstyleRules from nifi/pom.xml. 

Steps for IntelliJ users:

  1.  Download Checkstyle-IDEA plugin
  2. Install Download Checkstyle-IDEA plugin
  3. Install plugin by loading the downloaded zip from: Preferences -> Plugins -> Install plugin from disk...
  4. After restarting IntelliJ, configure Checkstyle plugin to use NiFi Checkstyle configuration file from: Preferences -> Other Settings -> Checkstyle
  5. Add nifi-checkstyle.xml in in Configuration File and activate it

...

  1. the configuration

Eclipse Users

Code formatter rules that adhere to our checkstyle rules can be found here.

Consider using the The Eclipse Checkstyle Plugin can be configured with our the project checkstyle rules to see what portions of your code are conflicting with our coding standard.
Consider installing these templates that help generate common Apache NiFi code snippets.  TODO: provide link.xml to evaluate conformance with project coding standards.

Contact us!

The developer mailing list (dev@nifi.apache.org) is monitored pretty closely, and we tend to respond quickly.  If you have a question, don't hesitate to shoot us an e-mail - we're here to help! Unfortunately, though, e-mails can get lost in the shuffle, so if you do send an e-mail and don't get a response within a day or two, it's our fault - don't worry about bothering us. Just ping the mailing list again.