-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README and created initial folder structure
- Loading branch information
1 parent
9a95b59
commit ad2a1d6
Showing
2 changed files
with
13 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |