From ad2a1d624fe2c1fbfa4166389b1a816e739af6e5 Mon Sep 17 00:00:00 2001 From: Chidiebere Nnadi Date: Wed, 28 Oct 2015 10:20:22 +0100 Subject: [PATCH] Updated README and created initial folder structure --- CONTRIBUTING.md | 2 ++ README.md | 12 +++++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5a4dcb6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,2 @@ +# Contributing +If you have something you want to add or remove, please open a new pull request. diff --git a/README.md b/README.md index 08584d9..3112145 100644 --- a/README.md +++ b/README.md @@ -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.