streampipes-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Justin Mclean <jus...@classsoftware.com>
Subject [MENTORS] Report formatting issues
Date Thu, 02 Jan 2020 00:56:12 GMT
Hi,

We had a large number of reports that needed manual editing to fix formatting issues this
month. Podlings that required to most changes have been BCCed.

Please try and follow teh instructions at the top of the page and and keep the formatting
consistent. 

II’s best to follow what is below:
• Do not change existing formatting.
• Keep all lines under 76 characters long.
• All content under the ### headings should be indented by two spaces. Do not use tabs.
• Please don't change the text in the headings or add new ones.
• Include a space after a bullet point or full stop on a numbered list.
• Use [X] (X and no spaces) to sign off reports.
• Do not include long URLs and use apache URL shortener https://s.apache.org.

Reflowing the text like below can fix some of the above issues but not all.

fold -w 76 -s $1 | cat -s

Thanks,
Justin


Mime
View raw message