Skip to content
This repository has been archived by the owner on Aug 16, 2019. It is now read-only.

Commit

Permalink
Update contribution_guidelines.md
Browse files Browse the repository at this point in the history
  • Loading branch information
deepshikha2k5 authored Nov 21, 2017
1 parent 9de9c75 commit 114726a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions pages/contributions/contribution_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,23 @@ You can use the following styles when formatting your document.

#### Titles and headings

**Use short descriptive titles**:Titles should be 80 characters or fewer. Avoid redundancy. All main headings and subheadings use sentence caps: only the first letter of the first word is capitalized. Everything else except proper names is in lowercase. (Sunbird is a proper name.)
**Use short descriptive titles**: Titles should be 80 characters or fewer. Avoid redundancy. For all main headings and subheadings use title case: only the first letter of the first word is capitalized. Everything else except proper names is in lowercase. (Sunbird is a proper name)

#### General text

Use short and appropriate sentences.Try to write in a very clear and concise manner. Avoid using jargons and words that are hard to understand. Be specific about who your audience is.
Use short and appropriate sentences. Try to write in a very clear and concise manner. Avoid using jargons and words that are hard to understand. Be specific about who your audience is.

#### Sentence length

Keep sentences to 15 words or fewer. Do not be wordy. Long sentences are difficult to understand.

#### Blocks

Code segments are usually written in blocks.Use blocks if code segments are more than one line.
Code segments are usually written in blocks. Use blocks if code segments are more than one line.

#### Contractions

Avoid using contractions , rather use the full word itself .
Avoid using contractions, rather use the full word itself.

#### Procedure style

Expand All @@ -69,7 +69,7 @@ Begin each item with a capital letter (unless it is a product or company name th

Be consistent, if possible, when writing the items in the list. Make them "parallel." In the first example, Get, Collaborate, and Voice are the same form of verb.

#### Numbers, Dates and Time
#### Numbers

* A billion is defined as an American billion: 1,000,000,000

Expand All @@ -87,9 +87,9 @@ ISO 8601 uses the 24-hour clock system. The basic format is [hh][mm][ss] and the

Use em dashes (HTML entity 8212, "—") for abrupt breaks in a sentence, to temporarily change subject within a sentence, for clarity, to draw attention to a point, or to signify the origin or author of a quotation.

* Don't use double hyphens; use the HTML entity.
* Donot use double hyphens; use the HTML entity.

* Don't place spaces on either side. There shouldn't be any space between the word or words next to an em dash and the en dash.
* Donot place spaces on either side. There shouldn't be any space between the word or words next to an em dash and the en dash.

Use an en dash (HTML entity 8211, "–") to indicate a range of numbers or dates. (See [www.alistapart.com/articles/emen/](http://www.alistapart.com/articles/emen/){:target="_blank"} for more information about the subject of dashes and hyphens.)

Expand Down

0 comments on commit 114726a

Please sign in to comment.