branch: externals/vc-jj
commit 69a160b280266cd0d33b6173b129d691c948f956
Author: Kristoffer Balintona <[email protected]>
Commit: Kristoffer Balintona <[email protected]>
Describe capitalization and terminology conventions
Also includes a few minor improvements elsewhere in the commentary.
---
vc-jj.el | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/vc-jj.el b/vc-jj.el
index de5f96b439..92e7bf29b5 100644
--- a/vc-jj.el
+++ b/vc-jj.el
@@ -46,10 +46,10 @@
;; FILE STRUCTURE
;;
;; After the "Customization" and "Internal Utilities" sections, the
-;; organization of this file follows the "BACKEND PROPERTIES" section
+;; organization of this file matches the "BACKEND PROPERTIES" section
;; of the preamble of the 'vc.el' file: each outline heading
-;; corresponding to a vc backend method and the contents of each
-;; heading relate to implementing that backend method.
+;; corresponds to a vc backend method and the contents of each heading
+;; relate to implementing that backend method.
;; FEEDBACK AND CONTRIBUTIONS
;;
@@ -63,7 +63,15 @@
;; so we ask contributors to try their best to use the terminology
;; specific to jujutsu as opposed to other version control systems,
;; such as Git. A brief description of these differences can be found
-;; above.
+;; in the README.
+;;
+;; Additionally, contributors should adhere to the following
+;; capitalization and terminology conventions:
+;; - "Jujutsu" refers to the Jujutsu version control system.
+;; - "jj" refers to the Jujutsu command-line tool or its commands.
+;; - "Jj" is used when "jj" would otherwise begin a sentence.
+;; - "vc-jj" may be used to refer to this Emacs package.
+;; - "Vc-jj" is used when "vc-jj" would otherwise begin a sentence.
;;; Code:
