airship/airshipctl
Code Issues Proposed changes

Guideline against very large Gerrit Changes

Browse Source 
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
This commit is contained in:
Noor Muhammad Malik 2020-07-03 21:35:25 +05:00
parent 507c842600
commit 2df0b1b331
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -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