diff options
author | Andrew Newdigate <andrew@gitlab.com> | 2017-06-02 15:42:34 +0300 |
---|---|---|
committer | Andrew Newdigate <andrew@gitlab.com> | 2017-06-02 15:42:34 +0300 |
commit | d35e6270b10d56f64d2c2bd26684e36ca5b37234 (patch) | |
tree | e27409fedc78ebb05f1e2e8bde89e76983a74b2b /CONTRIBUTING.md | |
parent | bb897859969075b7127773fb8d4d0956cf54530e (diff) |
make the readme better at radiating
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03a24f178..fa0c911e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,11 @@ This document describes requirements for merge requests to Gitaly. -### Changelog +## Style Guide + +The Gitaly style guide is [documented in it's own file](STYLE.md) + +## Changelog Any new merge request must contain either a CHANGELOG.md entry or a justification why no changelog entry is needed. New changelog entries @@ -12,3 +16,10 @@ If a change is specific to an RPC, start the changelog line with the RPC name. So for a change to RPC `FooBar` you would get: > FooBar: Add support for `fluffy_bunnies` parameter + +## GitLab CE changelog + +We only create GitLab CE changelog entries for two types of merge request: + +- adding a feature flag for one or more Gitaly RPC's (meaning the RPC becomes available for trials) +- removing a feature flag for one or more Gitaly RPC's (meaning everybody is using a given RPC from that point on) |