Intro to Style Guides (Activity)
From Foss2Serve
(Difference between revisions)
(→Suggestions for the Open Source Project:) |
|||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | {{Learning Activity Overview | ||
| + | |title= | ||
| + | The Need for Style Guides | ||
| + | |overview= | ||
| + | In this activity students will learn about why we need a style guide for team-based projects and compare style guides for a various projects. Based on this experience, students will develop a style guide for their team. | ||
| + | |prerequisites= | ||
| + | Knowledge of basic regular expressions is helpful to understand the checkstyle documentation. | ||
| + | |objectives= | ||
* Explain how a style guide contributes to a team project. | * Explain how a style guide contributes to a team project. | ||
* Develop a style guide for a project. | * Develop a style guide for a project. | ||
| − | |} | + | |process skills= |
| + | }} | ||
| − | === Background | + | === Background === |
Working by themselves on small projects convinces students that coding style his little relevance. As they begin work on HFOSS projects, they need to begin to build an appreciation for the place of a standardized coding style. | Working by themselves on small projects convinces students that coding style his little relevance. As they begin work on HFOSS projects, they need to begin to build an appreciation for the place of a standardized coding style. | ||
| Line 20: | Line 20: | ||
This topic is an opportunity for active debate about coding style, but is also a lesson in the need for accepting standards - even if they are not your preference. | This topic is an opportunity for active debate about coding style, but is also a lesson in the need for accepting standards - even if they are not your preference. | ||
| − | === Directions | + | === Directions === |
The following activities should be completed by the student before coming to class: | The following activities should be completed by the student before coming to class: | ||
| Line 28: | Line 28: | ||
* (60 minutes) In this video, Crockford uses JavaScript to illustrate key ideas about programming style | * (60 minutes) In this video, Crockford uses JavaScript to illustrate key ideas about programming style | ||
** https://www.youtube.com/watch?v=_EANG8ZZbRs | ** https://www.youtube.com/watch?v=_EANG8ZZbRs | ||
| − | * Read about the Google Style Guide | + | * (30 minutes) Read about the Google Style Guide |
** https://google-styleguide.googlecode.com/svn/trunk/javaguide.html | ** https://google-styleguide.googlecode.com/svn/trunk/javaguide.html | ||
| − | * | + | * (optional 15 minutes) Read this article about style versus standards |
| − | * | + | ** http://www.jrtwine.com/Articles/CodingStyles/CStyle1.htm |
| − | + | * (90 minutes) Checkstyle (http://checkstyle.sourceforge.net/) is one of a number of static analysis tools that provides a measure of the health of a codebase. | |
** Read the ~150 items checked, and determine if each should be included or excluded from the standards for your group project. For each item included, state appropriate parameters. | ** Read the ~150 items checked, and determine if each should be included or excluded from the standards for your group project. For each item included, state appropriate parameters. | ||
| + | Ideas for in-class activities: | ||
| + | |||
| + | * Some checkstyle items are controversial, providing an opportunity for lively debate. See items in the following categories | ||
| + | ** Metrics: http://checkstyle.sourceforge.net/config_metrics.html | ||
| + | ** Size Violations: http://checkstyle.sourceforge.net/config_sizes.html | ||
| + | ** Coding: http://checkstyle.sourceforge.net/config_coding.html | ||
| + | |||
| + | * Have students work in their groups to compare their assessment of the checkstyle items. Each group should develop a single style for their work. | ||
(optional) Install checkstyle for your favorite IDE: | (optional) Install checkstyle for your favorite IDE: | ||
| − | |||
* http://checkstyle.sourceforge.net/index.html#Related_Tools | * http://checkstyle.sourceforge.net/index.html#Related_Tools | ||
(optional) Add checkstyle to your build (ant, maven, etc.) | (optional) Add checkstyle to your build (ant, maven, etc.) | ||
| + | * ant: http://checkstyle.sourceforge.net/anttask.html | ||
| + | * maven: https://maven.apache.org/plugins/maven-checkstyle-plugin/ | ||
| + | * gradle: https://docs.gradle.org/current/userguide/checkstyle_plugin.html | ||
| + | === Deliverables === | ||
| − | + | Ideas for assignments: | |
| − | + | * A list of questions to answer as the student is reading the articles / watching the video | |
| + | * A journal assignment (informal writing) where students respond to the arguments in the article / video | ||
| + | * Use the Google and/or Sun checkstyle files to see how well student's existing code meets the style | ||
| + | ** Google style file: http://checkstyle.sourceforge.net/google_style.html | ||
| + | ** Sun style file: http://checkstyle.sourceforge.net/sun_style.html | ||
| − | === Assessment | + | === Assessment === |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | TBD | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| + | {{Learning Activity Info | ||
| + | |acm unit= | ||
| + | SE - Software Engineering | ||
| + | |acm topic= | ||
| + | SE/Software Process, SE/Tools and Environments, | ||
| + | |difficulty= | ||
| + | medium (because of the time required) | ||
| + | |time= | ||
| + | 2.5 hours preparing plus one class session | ||
| + | |environment= | ||
| + | Internet access, Java IDE | ||
| + | |author= | ||
| + | Ben Coleman | ||
| + | |source= | ||
| + | |license= | ||
| + | {{License CC BY SA}} | ||
| + | }} | ||
=== Suggestions for the Open Source Project: === | === Suggestions for the Open Source Project: === | ||
| Line 83: | Line 87: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | [[Category: | + | [[Category:Learning Activity]] |
| − | [[Category: | + | [[Category:Coding and Style]] |
| + | [[Category:CS1]] | ||
| + | [[Category:Good Draft]] | ||
Latest revision as of 18:45, 8 March 2017
| Title |
The Need for Style Guides |
|---|---|
| Overview |
In this activity students will learn about why we need a style guide for team-based projects and compare style guides for a various projects. Based on this experience, students will develop a style guide for their team. |
| Prerequisites |
Knowledge of basic regular expressions is helpful to understand the checkstyle documentation. |
| Learning Objectives |
After successfully completing this activity, the learner should be able to:
|
| Process Skills Practiced |
Background
Working by themselves on small projects convinces students that coding style his little relevance. As they begin work on HFOSS projects, they need to begin to build an appreciation for the place of a standardized coding style.
This topic is an opportunity for active debate about coding style, but is also a lesson in the need for accepting standards - even if they are not your preference.
Directions
The following activities should be completed by the student before coming to class:
- (30 minutes) This article talks about the need for a coding standard
- (60 minutes) In this video, Crockford uses JavaScript to illustrate key ideas about programming style
- (30 minutes) Read about the Google Style Guide
- (optional 15 minutes) Read this article about style versus standards
- (90 minutes) Checkstyle (http://checkstyle.sourceforge.net/) is one of a number of static analysis tools that provides a measure of the health of a codebase.
- Read the ~150 items checked, and determine if each should be included or excluded from the standards for your group project. For each item included, state appropriate parameters.
Ideas for in-class activities:
- Some checkstyle items are controversial, providing an opportunity for lively debate. See items in the following categories
- Have students work in their groups to compare their assessment of the checkstyle items. Each group should develop a single style for their work.
(optional) Install checkstyle for your favorite IDE:
(optional) Add checkstyle to your build (ant, maven, etc.)
- ant: http://checkstyle.sourceforge.net/anttask.html
- maven: https://maven.apache.org/plugins/maven-checkstyle-plugin/
- gradle: https://docs.gradle.org/current/userguide/checkstyle_plugin.html
Deliverables
Ideas for assignments:
- A list of questions to answer as the student is reading the articles / watching the video
- A journal assignment (informal writing) where students respond to the arguments in the article / video
- Use the Google and/or Sun checkstyle files to see how well student's existing code meets the style
- Google style file: http://checkstyle.sourceforge.net/google_style.html
- Sun style file: http://checkstyle.sourceforge.net/sun_style.html
Assessment
TBD
| ACM BoK Area & Unit(s) |
SE - Software Engineering |
|---|---|
| ACM BoK Topic(s) |
SE/Software Process, SE/Tools and Environments, |
| Difficulty |
medium (because of the time required) |
| Estimated Time to Complete |
2.5 hours preparing plus one class session |
| Environment / Materials |
Internet access, Java IDE |
| Author(s) |
Ben Coleman |
| Source | |
| License |
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License
|
Suggestions for the Open Source Project:
Suggestions for an open source community member who is working in conjunction with the instructor.
