Skip to content

Latest commit

 

History

History
17 lines (14 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

17 lines (14 loc) · 1.05 KB
Raw

Contributing

  1. Fork the repository.
  2. Add your section - make sure you follow the styling guide.
  3. Commit changes.
  4. Push your commit.
  5. Create a Pull Request.

Styling

  • Use ### headers for your sections.
  • Also use ### for categories (these should group together relevant sections) and #### for subcategories.
  • Add a link to your section/category to the contents section (use relative links).
  • Make sure to include examples wherever possible (preferably GIFs).
  • For command-line examples, wrap your commands in a bash code block. Ask @rafalchmiel or @tiimgreen to take a screenshot (so that it is consistent with the rest) of the output if it has color, etc.
  • At the end of your section, add a Read more about... link. This should directly link to Git's or GitHub's documentation.
  • If your contribution is a translation, add a (relative) link to the README above the Table of Contents.