Documentation Guidelines

Documentation Guidelines

Contributing

Each contributor to the documentation should follow the rules listed below

• When submitting a new file or new paragraphs of a file, the contributor should indent and justify the paragraphs as best as it can. Line breaks should be put at a reasonable length.
• When modifying an existing paragraph, the paragraph should not be re-indented or re-justified. It may look horrible and nasty, but the diffs would show up much better if the other lines of the paragraph are untouched.
• The changes should be submitted as PRs to the master branch.
• Remember to put a new line at the end of a file (C++-like)

Each Editor should follow the rules listed below

• When reviewing a PR, the editor can do the merge and perform all the editorial changes that are required.
• When deciding if re-indenting or re-justifying paragraph the editor should be aware of incoming changes on that same files and paragraphs from other users. If there are not incoming changes foreseen, the re-indentation and re-justification can be done to make the source files more readable.