CONTRIBUTING.md

Contribute to Git for Wizards

• 1. Sections Naming
• 2. Commit Message
  • 2.1. New Sections
  • 2.2. New Spells
• 3. Formating
  • 3.1. Markdown Rules
  • 3.2. Title Case
  • 3.3. Sections Numbering
  • 3.4. TOC
• 4. References

1. Sections Naming

Spells should have names inspired from magic spells like the ones used in J.K. Rowling's Harry Potter or any other similar alternative.

2. Commit Message

2.1. New Sections

Add {SECTION_NAME} Section

Example

Add Markdown Beautifio Section

2.2. New Spells

Add {NUMBER} New Spells to {SECTION_NAME}

 * {SPELL_NAME}
 * {SPELL_NAME}

Example

Add 2 New Spells to Markdown Beautifio

 * Keyboard Key Strokes
 * Mathematics Equations

3. Formating

3.1. Markdown Rules

• Follow these rules while writing markdown.
• Use markdownlint for Markdown linting and style checking in Visual Studio Code.

3.2. Title Case

• When writing a name or a title, it is a common convention to only use capital letters to start the principal words.
• Non-principal words are written with a lowercase letter unless they start the title.
• Non-principal words:
  1. Articles (a, an, the, etc.)
  2. Conjunctions (and, but, or, etc.)
  3. Prepositions (on, in, with, etc.)

3.3. Sections Numbering

• Use Markdown TOC to update Sections Numbering after adding new section or spell.

3.4. TOC

• Use Markdown TOC to update Table of Contents after adding new section or spell.
• Sections name is written in BOLD.

4. References

• References should always be cited in the References and Acknowledgments section at the end of the README.md file.
• Cited references should be arranged in alphabetical order.