From 1cf7bc7a6345fdcab6c68742a7eb840911ebe0f5 Mon Sep 17 00:00:00 2001 From: Yash Sharma Date: Fri, 14 Oct 2016 23:41:41 +0530 Subject: [PATCH] add new guideline in CONTRIBUTING.md (#1116) * Update CONTRIBUTING.md * add missing quotes in contributing.md * Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81abf6b7d..591d6d774 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ Here are a few guidelines to get started: 1. Focus on the 5 or 6 most common usages. It's OK if the page doesn't cover everything; that's what `man` is for. 2. When in doubt, keep new command-line users in mind. - Err on the side of clarity rather than terseness. + Err on the side of clarity rather than terseness. For example, commands that require `sudo` should include it directly in the examples. 3. Try to incorporate the spelled-out version of single-letter options in the example's description. The goal is to allow people to *understand* the syntax of the commands, not just *memorize* it. 4. Introduce options gradually, starting with the simplest command invocations,