summaryrefslogtreecommitdiff
path: root/doc/development/limit_ee_conflicts.md
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2017-02-16 17:43:49 +0100
committerRémy Coutable <remy@rymai.me>2017-02-16 17:57:03 +0100
commitc6ab1e9d36e3791f5938078cb52f2b67ec4f977d (patch)
tree2dadc089d47121cf9e3ab134af262335f351b588 /doc/development/limit_ee_conflicts.md
parent2d2cdd64306a69aba852dd3ce26cb89b1c25655c (diff)
downloadgitlab-ce-c6ab1e9d36e3791f5938078cb52f2b67ec4f977d.tar.gz
Document better the CE -> EE mergedocument-ce-to-ee
Signed-off-by: Rémy Coutable <remy@rymai.me>
Diffstat (limited to 'doc/development/limit_ee_conflicts.md')
-rw-r--r--doc/development/limit_ee_conflicts.md25
1 files changed, 16 insertions, 9 deletions
diff --git a/doc/development/limit_ee_conflicts.md b/doc/development/limit_ee_conflicts.md
index 568dedf1669..2d82b09f301 100644
--- a/doc/development/limit_ee_conflicts.md
+++ b/doc/development/limit_ee_conflicts.md
@@ -2,19 +2,26 @@
This guide contains best-practices for avoiding conflicts between CE and EE.
-## Context
+## Daily CE Upstream merge
-Usually, GitLab Community Edition is merged into the Enterprise Edition once a
-week. During these merges, it's very common to get conflicts when some changes
-in CE do not apply cleanly to EE.
+GitLab Community Edition is merged daily into the Enterprise Edition (look for
+the [`CE Upstream` merge requests]). The daily merge is currently done manually
+by four individuals.
-There are a few things that can help you as a developer to:
+**If a developer pings you in a `CE Upstream` merge request for help with
+resolving conflicts, please help them because it means that you didn't do your
+job to reduce the conflicts nor to ease their resolution in the first place!**
-- know when your merge request to CE will conflict when merged to EE
-- avoid such conflicts in the first place
-- ease future conflict resolutions if conflict is inevitable
+To avoid the conflicts beforehand when working on CE, there are a few tools and
+techniques that can help you:
-## Check the `rake ee_compat_check` in your merge requests
+- know what are the usual types of conflicts and how to prevent them
+- the CI `rake ee_compat_check` job tells you if you need to open an EE-version
+ of your CE merge request
+
+[`CE Upstream` merge requests]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests?label_name%5B%5D=CE+upstream
+
+## Check the status of the CI `rake ee_compat_check` job
For each commit (except on `master`), the `rake ee_compat_check` CI job tries to
detect if the current branch's changes will conflict during the CE->EE merge.