From d35e6270b10d56f64d2c2bd26684e36ca5b37234 Mon Sep 17 00:00:00 2001 From: Andrew Newdigate Date: Fri, 2 Jun 2017 12:42:34 +0000 Subject: make the readme better at radiating --- CONTRIBUTING.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'CONTRIBUTING.md') 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) -- cgit v1.2.3