Intro to Style Guides (Activity)
From Foss2Serve
| Title | The Need for Style Guides |
| Overview | In this activity you 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, you will develop a style guide for your team. |
| Prerequisite Knowledge | What topics and tools does the student need to know prior to beginning this activity? |
| Learning Objectives | Upon completion of this activity, you will be able to:
|
Background:
Is there background reading material?
Are there other activities the student should have done first?
What is the rational for this activity?
Include helpful hints to faculty here.
Directions:
In-class activity:
- look at three versions of the same code
- which do you like best? worst? why?
- discuss consistency of code
Deliverables:
What will the student hand in?
Assessment:
How will the activity be graded?
How will learning will be measured?
Include sample assessment questions/rubrics.
Comments:
What should the instructor know before using this activity?
What are some likely difficulties that an instructor may encounter using this activity?
Additional Information:
| 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? |
| Topic | What specific topics are addressed? The Computing Curriucula 2013 provides a list of topics - https://www.acm.org/education/CS2013-final-report.pdf |
| Level of Difficulty | Is this activity easy, medium or challenging? |
| Estimated Time to Completion | How long should it take for the student to complete the activity? |
| Materials/Environment | What does the student need? Internet access, IRC client, Git Hub account, LINUX machine, etc.? |
| Author | Who wrote this activity? |
| Source | Is there another activity on which this activity is based? If so, please provide a link to the original resource. |
| License | Under which license is this material made available? (http://creativecommons.org/licenses/) |
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
