This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • Code Submission and Review Guidelines
Skip to end of metadata
Go to start of metadata

Any new feature, enhancements to existing features, a new plugin addition, etc to CloudStack,  then the patch or code merge should have below things available and verified at minimum:
 

  1. Effective Unit tests
  2. Effective Integration tests written for Marvin, covering sanity and other feature functionality
  3. No Check Style Issues reported.
  4. Should have passed BVT on simulator at least. Check the below link for usage on Simulator, if we can run hardware tests and added functionality change effects that code, then hardware tests also should run and pass.
     https://cwiki.apache.org/confluence/display/CLOUDSTACK/Validating+check-ins+for+your+local+changes%2C+using+Simulator
  5. 0 Static analysis issues reported in new code addition, either through findbugs, coverity, pmd etc. How to use findbugs at the link below:
    https://cwiki.apache.org/confluence/display/CLOUDSTACK/Using+FindBugs 
  6. Effective documentation or wiki page updates.
  7. Have enough code documentation available for users to understand the code flow.
  8. Have effective exception handling and appropriate logging information 
  9. Avoid hard coded values where possible and move them to config.
  10. Follow common naming conventions and practices as adhered in other available modules.
  11. Avoid exact copy paste code and duplicate code.
  12. Submit the test run logs, static analysis reports, and other misc information to the submission.
  13. Any new command addition or existing interface modification, corresponding changes to simulator code as well need to be added.

***** Reviewers can enforce  these and inquire at the time of reviewing submissions.

 

  • No labels