opendev/gerrit
Code Issues Proposed changes

Add some submit rules best practices to documentation

Browse Source 
Change-Id: I0e6a018885c08583d208045e84ecc1d73ba0c55d
This commit is contained in:
Maxime Guerreiro
2018-06-06 13:36:50 +00:00
parent 18c7aaba36
commit 97e891a99d
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/dev-plugins.txt
View File

@@ -2861,6 +2861,17 @@ public class MyPluginModule extends AbstractModule {
Plugin authors should also consider binding their SubmitRule using a `Gerrit-BatchModule`.
See link:dev-plugins.html[Batch runtime] for more informations.
The SubmitRule extension point allows you to write complex rules, but writing
small self-contained rules should be preferred: doing so allows end users to
compose several rules to form more complex submit checks.
The `SubmitRequirement` class allows rules to communicate what the user needs
to change in order to be compliant. These requirements should be kept once they
are met, but marked as `OK`. If the requirements were not displayed, reviewers
would need to use their precious time to manually check that they were met.
== SEE ALSO
* link:js-api.html[JavaScript API]