diff options
| author | Amar Tumballi <amarts@redhat.com> | 2018-07-20 10:34:28 +0530 |
|---|---|---|
| committer | Vijay Bellur <vbellur@redhat.com> | 2018-09-11 22:55:23 +0000 |
| commit | 763eb83dcbaf6a319fc2346fc696ab079e425ee3 (patch) | |
| tree | fc45eb15dc9b1c2c038ae0ec7c59f5f32c511e99 /doc | |
| parent | 343f5a1ee0567363fc30a06f83e3e77aec0d2b2e (diff) | |
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 <amarts@redhat.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 8 |
1 files changed, 8 insertions, 0 deletions
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/). |