Skip to content

Commit

Permalink
Updated README and created initial folder structure
Browse files Browse the repository at this point in the history
  • Loading branch information
afropolymath committed Oct 28, 2015
1 parent 9a95b59 commit ad2a1d6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Contributing
If you have something you want to add or remove, please open a new pull request.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# Code Review Guidelines
The purpose of this document is to define standards for all code reviews done by Trainers in Andela. These guidelines are to be applied for checkpoint assessments as well as regular day to day code reviews performed in your role as Senior Engineer.
The purpose of this guide is to define standards for all code reviews done by Trainers in Andela and also ensure that code written by Andela fellows are top notch and excellent. These guidelines are to be applied for checkpoint assessments as well as regular day to day code reviews performed in your role as Senior Engineer.

As a Senior Engineer, code review is one of the most important aspects of what you do and doing it right is instrumental to grooming the right type of engineers and writing effective code in general.

Most of the information provided in this document was adopted from the [Thoughtbot Code Review Guide](https://github.com/thoughtbot/guides/tree/master/code-review).

## Table of Contents
- [Behavioural Practices for Reviewers and Reviewees](http://github.com/andela/code-review-guidelines/blob/master/behavioural-practices)
- [Before you start reviewing](http://github.com/andela/code-review-guidelines/blob/master/behavioural-practices)
- [Initial Code Quality Checks](http://github.com/andela/code-review-guidelines/blob/master/behavioural-practices)
- [Coding Style Guides](http://github.com/andela/code-review-guidelines/blob/master/behavioural-practices)
- [Best Practices](http://github.com/andela/code-review-guidelines/blob/master/behavioural-practices)
- [Code Performance](http://github.com/andela/code-review-guidelines/blob/master/behavioural-practices)

## Contributing
Please read the [contribution guidelines](http://github.com/andela/code-review-guidelines/blob/master/CONTRIBUTING.md) before submitting a pull request.

0 comments on commit ad2a1d6

Please sign in to comment.