Intro to Style Guides (Activity)

(Difference between revisions)
Jump to: navigation, search
Line 68: Line 68:
 
{| border="1"
 
{| border="1"
 
|-  
 
|-  
−
|'''Knowledge Area/Knowledge Unit''' || What ACM Computing Curricula 2013 https://www.acm.org/education/CS2013-final-report.pdf knowledge area and units does this activity cover?
+
|'''Knowledge Area/Knowledge Unit''' || SE - Software Engineering
 
|-
 
|-
−
|'''Topic''' || What specific topics are addressed? The Computing Curriucula 2013 provides a list of topics - https://www.acm.org/education/CS2013-final-report.pdf
+
|'''Topic''' || SE/Software Process, SE/Tools and Environments,
 
|-
 
|-
−
|'''Level of Difficulty''' || Is this activity easy, medium or challenging?
+
|'''Level of Difficulty''' || medium (because of the time required)
 
|-
 
|-
−
|'''Estimated Time to Completion''' ||  How long should it take for the student to complete the activity?
+
|'''Estimated Time to Completion''' ||  2.5 hours preparing plus one class session
 
|-
 
|-
−
|'''Materials/Environment''' || What does the student need?  Internet access, IRC client, Git Hub account, LINUX machine, etc.?
+
|'''Materials/Environment''' || Internet access, Java IDE
 
|-
 
|-
−
|'''Author''' || Who wrote this activity?
+
|'''Author''' || Ben Coleman
 
|-
 
|-
−
|'''Source''' || Is there another activity on which this activity is based?  If so, please provide a link to the original resource.
+
|'''Source''' || N/A
 
|-
 
|-
−
|'''License''' || Under which license is this material made available? (http://creativecommons.org/licenses/)
+
|'''License''' || Creative Commons Attribution-ShareAlike 4.0 International License
−
|}
+
  
  

Revision as of 13:55, 28 May 2015

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.
Prerequisite Knowledge Knowledge of basic regular expressions is helpful to understand the checkstyle documentation.
Learning Objectives Upon completion of this activity, students will be able to:
  • Explain how a style guide contributes to a team project.
  • Develop a style guide for a project.

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

Additional Information:

Knowledge Area/Knowledge Unit SE - Software Engineering
Topic SE/Software Process, SE/Tools and Environments,
Level of Difficulty medium (because of the time required)
Estimated Time to Completion 2.5 hours preparing plus one class session
Materials/Environment Internet access, Java IDE
Author Ben Coleman
Source N/A
License 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.


This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License

CC license.png

Retrieved from "http://foss2serve.org/index.php?title=Intro_to_Style_Guides_(Activity)&oldid=3699"
Personal tools
Namespaces
Variants
Actions
Events
Learning Resources
HFOSS Projects
Evaluation
Navigation
Toolbox