From 763eb83dcbaf6a319fc2346fc696ab079e425ee3 Mon Sep 17 00:00:00 2001 From: Amar Tumballi Date: Fri, 20 Jul 2018 10:34:28 +0530 Subject: doc: add coding-standard and commit-msg link in README Having the links in README makes people follow it if they browse through github. Updates: bz#1193929 Change-Id: I580332a41d9b52858aa9796a74a563ff57a60b4b Signed-off-by: Amar Tumballi --- doc/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/README.md b/doc/README.md index 6294df94b67..8a92bd990d0 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,3 +1,11 @@ +## Developer Guide + +Gluster's contributors can check about the internals by visiting [Developer Guide Section](developer-guide). While it is not 'comprehensive', it can help you to get started. + +Also while coding, keep [Coding Standard](developer-guide/coding-standard.md) in mind. + +When you are ready to commit the changes, make sure you meet our [Commit message standard](developer-guide/commit-guidelines.md). + ## Admin Guide ## The gluster administration guide is maintained at [github](https://github.com/gluster/glusterdocs). The browsable admin guide can be found [here](http://docs.gluster.org/en/latest/Administrator%20Guide/). -- cgit