README sample

README.md

Project

Some description how is awesome the project.

How to hit the ground running

• Follow installation instructions in doc/INSTALLATION
• Follow deployment instructions in doc/DEPLOYMENT
• Follow workflow process in doc/WORKFLOW

General coding recommendations

• Use GitHub's styleguide: Ruby Styleguide.
• Don't comment out code (don't increase the "technical debt").
• Use GitHub comments as the code review tool.

Database

• Group ActiveRecord macro-style methods (has_many, validates, etc) in the beginning of the class definition.
• All migrations should be revertable and tested that down method works properly before push to the repository.
• Inrevertable migrations should give warnings but do not stop migration process.

Tests

• Each implemented story should have acceptance test covering all accepptance criterias provided in spec.
• Run autotest to run test instantly, triggered by project changes. Autotest does not replace whole test suite run after pull/push to origin flow.

Security

• Mass-assignment is disabled by default. All public fields accessible by user should be listed in attr_accessible class method of model.

Git

• Rebase is prefered over merge. There should not be any merge commits.
• Combine commits with git squash to have useful history.

Definition of Done

These criteria need to be fulfilled for the story to be marked as "resolved" in the project management application.

• The story is implemented and tests are created.
• The story passes the acceptance tests.
• The story does not increase the "technical debt".
• The story was integrated into the overall system.
• The story was successfully deployed to the staging environment.