Skip to content

Commit a44851b

Browse files
committed
Merge branch '4.4' into 5.2
* 4.4: Command naming conventions
2 parents 236d632 + ce5f517 commit a44851b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

contributing/code/conventions.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,3 +227,11 @@ of the impacted component:
227227
* Remove the `Deprecated` class, use `Replacement` instead
228228
229229
This task is mandatory and must be done in the same pull request.
230+
231+
Naming Commands and Options
232+
---------------------------
233+
234+
Commands and their options should be named and described using the English
235+
imperative mood (i.e. 'run' instead of 'runs', 'list' instead of 'lists'). Using
236+
the imperative mood is concise and consistent with similar command-line
237+
interfaces (such as Unix man pages).

0 commit comments

Comments
 (0)