From 2df0b1b331a1b26004f2829822b99189d731f1e8 Mon Sep 17 00:00:00 2001 From: Noor Muhammad Malik Date: Fri, 3 Jul 2020 21:35:25 +0500 Subject: [PATCH] Guideline against very large Gerrit Changes This adds a note into the CONTRIBUTING.md file to discourage creation of extremely large changes in the project that are very difficult to review. Change-Id: I416082854024d81cfca1a047e1281f582c3e2fa5 Relates-To: #289 Closes: #289 --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52ad0fb74..d31a43110 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,6 +75,13 @@ change. This method is considered a fallback in lieu of the other two methods. Any issue references should be evaluated within 15 minutes of being uploaded. +**NOTE** Make sure to carefully divide the work into logical chunks to avoid +creating changes that are too large. Such practices are discouraged and make +code review very difficult. Break down the work into components and create a +separate change for each component. Keep a design document or README to +track the overall progress when making a large contribution. +See [OSF Guidelines](https://docs.openstack.org/contributors/code-and-documentation/patch-best-practices.html#the-right-size) for more information. + ## Reviewing Changes Another great way to contribute to the project is to review changes made by