Policy Framework Project: Software Development Best Practices

Owned by Pamela Dragosh
Last updated: Dec 11, 2019
1 min read

The policy development team is committed to adhering to S3P Usability Level 1 guidelines and ONAP Recommended Software Development Best Practices: Developer Best Practices

The following requirements should be adhered to in order to help support maintaining above guidelines. Adherence assists the Committers and Contributors with Code Reviews and future ability of developers to understand, help maintain, and extend the software contributed.

Policy repositories inherit from oparent which supports Checkstyle Plugin to ensure the code meets Java Code Style requirements. In addition, each repository enforces checkstyle by overriding oparent 

failsOnViolation=true 

violationSeverity=warning

Note: There are some overrides of class names leftover from Casablanca release that will be fixed in Dublin Release.



The following pages give instructions on how to setup your editor to continue to enforce checkstyle requirements in your developer environment. By doing so, this will prevent unnecessary CI/CD job verify failures.

Policy Developer Environment: Setting up Eclipse

Policy Developer Environment - Setting up IntelliJ



If you do not use these editors, just a simple "mvn compile" from a command line terminal should identify checkstyle issues.