Module 1 Assessment Starter Kit

Read the Evaluation Rubric at the end of this README to familiarize yourself with the grading.

This project will serve as the jumping-off point for several module one assessment challenges. Before your assessment, you should clone this repository, run bundle, and make sure all the tests pass by running rake.

Then, spend a few minutes to familiarize yourself with the structure and contents of the project. So far it contains a single Ruby module, an empty class, and some accompanying tests.

Running Tests

From the project's root, rake like a boss.

Installing Dependencies

You will probably already have the gems needed for this project already on your machine, but if not, bundle.

Where do you go from here?

Your instructors will provide notes to accompany this repo.

Evaluation Rubric

The project will be assessed with the following guidelines:

4: Above expectations
3: Meets expectations
2: Below expectations
1: Well-below expectations

1. Ruby Syntax & Style

4: Above expectations
3: Meets expectations
2: Below expectations
1: Well-below expectations

Applies appropriate attribute encapsulation
Developer creates instance and local variables appropriately
Idiomatic naming conventions followed
Ruby methods used are logical and readable
Developer implements best-choice enumerable methods
Code is indented properly
Code does not exceed 80 characters per line

2. Breaking Logic into Components

4: Above expectations
3: Meets expectations
2: Below expectations
1: Well-below expectations

Code is effectively broken into methods & classes
Developer has no more than 2 methods over 10 lines
No methods break the principle of SRP

3. Test-Driven Development

4: Above expectations
3: Meets expectations
2: Below expectations
1: Well-below expectations

Each method is unit tested
Functionality is accurately covered
Tests implement Ruby syntax & style
Balances unit and integration tests
Evidence of edge case testing

4. Version Control

4: Above expectations
3: Meets expectations
2: Below expectations
1: Well-below expectations

Developer created a branch for each iteration
Developer commits at a pace of at least 3 commits per hour

5. Completed Functionality

4: Above expectations
3: Meets expectations
2: Below expectations
1: Well-below expectations

CaptainSpectacular/company-audit