Skip to content

Coding Standards

Prasad Talasila edited this page Apr 16, 2018 · 10 revisions

Adherence to the following coding standards would be good.

  1. What counts finally are the Tested Features in Use.
  2. Three values of any software are: features, simple design and feedback. Testing is the only way to simplify the design. So consider improvement in all the three values.
  3. A stable release is mandatory for stable and predictable end-user installation.
  4. Adherence to java script coding standards as prescribed by Java Script : The Good Parts, Douglas Crockford
    Before each commit, a committer runs JSHint, JSLint and JSLint Errors on the code-base and fixes all the error and warning messages.
  5. Adherence to java coding standards as prescribed by PMD, CheckStyle and FindBugs
    Before each commit, a committer runs all three above mentioned tools on the code-base and fixes all the error and warning messages. All the three quality control tools come packaged in a maven tool named qulice.
    All of the above tools are also part of Codacy online service. Include the same in the GitHub project.
  6. Include Coveralls for test coverage reports.
  7. Creation and adherence to coding standard checklist. At the moment, we are following the project checklist from MIT course, 6.170 Software Studio
  8. An issue reported should have a detailed bug report that can help replicate the problem.

References

  1. Clean code in Javascript
  2. RTF : A Metric Leading to Agility, Ron Jeffries.
  3. Measuring Agile Projects Using Running Tested Features Metrics, Priyanjana Deb and Abhik Datta
  4. The Joel Test: 12 steps to Better Code, Joel Spolsky
  5. Brian W Kernighan on Testing
  6. Twelve-factor apps
  7. Agile Manifesto
  8. Software project best practices checklist, Kristóf KOVÁCS
  9. Development process - Mike Perks @ IBM
  10. JB Rainsberger - An introduction to Agile Software Development, Economics of Software Design
  11. CD in Java - Tool review
  12. java-source -- Open Source Software Tools in Java
  13. CI best practices check list - Piotr Oktaba
  14. Online documentation using javadoc.io
Clone this wiki locally