QA Part 1: Coding standards | ICS 314, Fall 2015

Learning Outcomes

Efficiently create software that conforms to standards

You understand the benefits of coding standards and why they improve the quality and efficiency of software development.
You can recognize the presence (or absence) of standards and make software conform if necessary.
You can take advantage of tool support to automate compliance with certain standards.

Create high quality technical essays

You demonstrate the ability to write professional-quality technical essays.

Assessments

A12: Assess your ability to detect coding standards violations

WOD 01 Oct 09:00 AM

Outcomes assessed: Use an IDE (IntelliJ IDEA) effectively, Efficiently create software that conforms to standards

Rx: < 25 min Av: 25-35 min Sd: 35-45 min DNF: 45+ min or incorrect

This in-class WOD assessed your ability to detect and remove coding standard violations using IntelliJ and GitHub.

Discussion:

This was a “party WOD” due to my conducting the class over Slack. While there was a LOT of time provided for this WOD, most of the class somehow waited until the last minute to finish.
Many repos contained IntelliJ files (.idea directory or *.iml files). While this was a violation of the coding standards, I did not DNF for this issue.
Several students had such minimal READMEs and/or GitHub pages that they basically did not tell the user anything useful about how to run the code or even what the code did.
My hope is that with additional practice those who DNFed will become more efficient at producing useful documentation.

A13: Assess your ability to write about your coding standard experiences

01 Oct 09:00 AM

Outcomes assessed: Efficiently create software that conforms to standards, Create high quality technical essays

This assessment evaluated your technical essay regarding the Coding Standards module for clarity, insight, and conformance to the technical essay guidelines.

Discussion:

All of the essays were at least satisfactory, but none really got to the “excellent” level for me. Maybe coding standards just isn’t quite inspiring enough material?

Module: QA Part 1: Coding standards

Learning Outcomes

Efficiently create software that conforms to standards

Create high quality technical essays

Readings

Guided tour of the coding standards module

Coding standards

Javascript coding standards

GitHub Standards

Sample .gitignore file

How to write a git commit message

IntelliJ IDEA Help: JSDoc

JSHint Documentation

IntelliJ IDEA Help: JSHint

Sample .jshintrc file

Experiential Learning

E30: Experience creating standards-compliant UH degree data

E31: Reflect on Coding Standards

Assessments

A12: Assess your ability to detect coding standards violations

A13: Assess your ability to write about your coding standard experiences