Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 616 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 616 Bytes

CONTRIBUTING TO DOCUMENTATION

If you are contributing to the documentation of the project, follow these guidelines:

  • ## for directory
  • ### for file
    • If the file does not have any functions in it, describe what the file does.
  • #### for any function or usable variable in the file.
  • If the file contains a class, use #### for the class.
    • Use ##### for any function in the class.

  • Keep a space between # and the heading text.
  • Leave a line after every heading.

Table of contents generator:

https://github.com/ekalinin/github-markdown-toc