- Every example has to be in its own folder. The name of the folder should tell the reader what the example shows.
- Contents of that folder:
- Every example has to have a
Makefile
which contains all the commands necessary to compile the document. - The main TeX file should have the same name as the folder.
- Every example has to have a
README.md
. For images / graphic examples, this should include the rendered image. For documents, there should be some example text explaining what it is about.
- Every example has to have a
- Use spaces for indenting.
- Don't have trailing spaces.
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how