com php-langspec: Add FORMATTING.md: FORMATTING.md

Commit: 9433805e7094d35787c541006ef8105f08f6e1f5 Author: Florian Anderiasch <fa@php.net> Wed, 30 Jul 2014 20:08:22 +0200 Committer: Stanislav Malyshev <smalyshev@gmail.com> Wed, 30 Jul 2014 17:45:07 -0700 Parents: df6f5ca7c63d591127539ea2a7bc352ee0a8fd91 Branches: master Link: http://git.php.net/?p=php-langspec.git;a=commitdiff;h=9433805e7094d35787c541006ef8105f08f6e1f5 Log: Add FORMATTING.md Changed paths: A FORMATTING.md Diff: diff --git a/FORMATTING.md b/FORMATTING.md new file mode 100644 index 0000000..9fa5aa7 --- /dev/null +++ b/FORMATTING.md @@ -0,0 +1,16 @@ +# Formatting rules + +1. The format of this document is [Markdown](http://daringfireball.net/projects/markdown/) +2. Everything in the actual specification document must be ASCII only. +3. The markdown specification used seems to be *plain markdown* with tables and + code blocks (three backticks). +4. Style + * Use spaces to indent, not tabs. + * Use of prefixed ## is preferred for headers over underlined === + * Use of *inline* links [example](http://example.org) is preferred over + *reference* links [example][xmpl] unless used multiple times. This is to + allow for easier splitting and reorganization. + * Do not embed external images not hosted on php.net. + * Try to stick to 80 chars wide, if possible. This is not as strict as + in code, but still easier to read most of the times. This does only apply + to text, not to code examples or tables.