X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=contrib-guide.md;h=4f45918a5a9463dc1b815d3aed971978470cfa27;hb=b51e6d8efcf4eb2a9feb47999f8c773ce9b85637;hp=5ae90797f85a603b33272795c9ff54fd1354ac1f;hpb=e70fc4f424bbefc42f46a7aa0c015e201352e897;p=lttng-docs.git diff --git a/contrib-guide.md b/contrib-guide.md index 5ae9079..4f45918 100644 --- a/contrib-guide.md +++ b/contrib-guide.md @@ -88,8 +88,11 @@ Tip/note block: ``` -Title should be `Tip:` for a tip and `Note:` for a note. +Replace the `tip` class with `warn` for a warning block, and with `err` +for an error message block (when JavaScript is needed but is disabled, etc.). +Title should be `Tip:` for a tip, `Note:` for a note, `Warning:` for a +warning, and `Error:` for an error. #### External links @@ -236,7 +239,9 @@ consistent as possible: (good: `include/trace/events`, bad: `include/trace/events/`). * Keep the text as impersonal as possible (minimize the use of _I_, _we_, _us_, etc.), except for user guides/tutorials where - _we_ have an ongoing example. + _we_ have an ongoing example with _you_. + * Minimize the use of the future tense (_will_). + * Do not use Latin abbreviations (_e.g._, _i.e._, _etc._). Committing