Intro to Style Guides (Activity)

From Foss2Serve
(Difference between revisions)
Jump to: navigation, search
(Suggestions for the Open Source Project:)
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
  
{| class="wikitable"
+
{{Learning Activity Overview
|-
+
|title=
| '''Title''' || The Need for Style Guides
+
The Need for Style Guides
|-
+
|overview=
| '''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.
+
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=
| '''Prerequisite Knowledge''' || Knowledge of basic regular expressions is helpful to understand the checkstyle documentation.
+
Knowledge of basic regular expressions is helpful to understand the checkstyle documentation.
|-
+
|objectives=
| '''Learning Objectives''' || Upon completion of this activity, students will be able to:
+
 
* 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 ===
Line 65: Line 65:
 
TBD
 
TBD
  
=== Additional Information ===
+
{{Learning Activity Info
 
+
|acm unit=
{| class="wikitable"
+
SE - Software Engineering
|-
+
|acm topic=
| '''Knowledge Area/Knowledge Unit''' || SE - Software Engineering
+
SE/Software Process, SE/Tools and Environments,
|-
+
|difficulty=
| '''Topic''' || SE/Software Process, SE/Tools and Environments,
+
medium (because of the time required)
|-
+
|time=
| '''Level of Difficulty''' || medium (because of the time required)
+
2.5 hours preparing plus one class session
|-
+
|environment=
| '''Estimated Time to Completion''' ||  2.5 hours preparing plus one class session
+
Internet access, Java IDE
|-
+
|author=
| '''Materials/Environment''' || Internet access, Java IDE
+
Ben Coleman
|-
+
|source=
| '''Author''' || Ben Coleman
+
|license=
|-
+
{{License CC BY SA}}
| '''Source''' || N/A
+
}}
|-
+
| '''License''' || Creative Commons Attribution-ShareAlike 4.0 International License
+
|}
+
 
+
  
 
=== Suggestions for the Open Source Project: ===
 
=== Suggestions for the Open Source Project: ===
Line 91: Line 87:
  
  
--------------------
 
This work is licensed under a
 
[http://creativecommons.org/licenses/by-sa/4.0/ Creative Commons Attribution-ShareAlike 4.0 International License]
 
 
[[File:CC_license.png]]
 
  
[[Category: Learning_Activity]]
+
[[Category:Learning Activity]]
[[Category:Coding_and_Style]]
+
[[Category:Coding and Style]]
[[Category: CS1]]
+
[[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:
  • Explain how a style guide contributes to a team project.
  • Develop a style guide for a project.
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:

Ideas for in-class activities:

  • 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.)

Deliverables

Ideas for assignments:

Assessment

TBD

ACM Body of Knowledge
Area & Unit(s)

SE - Software Engineering

ACM Topic(s)

SE/Software Process, SE/Tools and Environments,

Level of Difficulty

medium (because of the time required)

Estimated Completion Time

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

CC license.png


Suggestions for the Open Source Project:

Suggestions for an open source community member who is working in conjunction with the instructor.

Personal tools
Namespaces
Variants
Actions
Events
Learning Resources
HFOSS Projects
Evaluation
Navigation
Toolbox