tex-projects/LaTeX-examples
2
0
Fork 0
mirror of https://github.com/MartinThoma/LaTeX-examples.git synced 2025-04-11 15:38:15 +02:00
Code Activity
LaTeX-examples/CONTRIBUTING.md
Martin Thoma 7740f0147f Remove trailing spaces 
The commands

find . -type f -name '*.md' -exec sed --in-place 's/[[:space:]]\+$//' {} \+

and

find . -type f -name '*.tex' -exec sed --in-place 's/[[:space:]]\+$//' {} \+

were used to do so.
2015-10-14 14:25:34 +02:00

935 B
Raw Permalink Blame History

Structure

  1. Every example has to be in its own folder. The name of the folder should tell the reader what the example shows.
  2. Contents of that folder:
    1. Every example has to have a Makefile which contains all the commands necessary to compile the document.
    2. The main TeX file should have the same name as the folder.
    3. 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.
  3. Use spaces for indenting.
  4. Don't have trailing spaces.

Commit messages

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how