From 1d3c1e72c63114fee14beeec28c16f3ff867596f Mon Sep 17 00:00:00 2001 From: gaboesquivel Date: Tue, 17 Jul 2018 10:28:41 -0600 Subject: [PATCH] docs(readme): add a code base section to contributing.md --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62b6f44..80f414b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,7 @@ - [Development Process](#development-process) +- [The Code Base](#the-code-base) - [Pull Request General Guidelines](#pull-request-general-guidelines) - [Commit Message Guidelines](#commit-message-guidelines) - [Commit Message Format](#commit-message-format) @@ -49,6 +50,17 @@ New and reopened pull request are automatically added to the board in the In Pro When the pull request is closed is moved to the Done column automatically. If the pull request closes and issues it is properly stated with the github keywords closes in the pull request it gets automatically moved to the Done column too. +## The Code Base + +We make an effort to keep the code clean and readable, with comments as necessary, and also providing appropriate documentation in our readme files. If you are starting out please make sure you read the documentation first. This is a funfunfunction video with **5 tips to quickly understand a new code base** : + +

+ + + +

+ + ## Pull Request General Guidelines * Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned.