1 Contributing to The CookBook
The CakePHP community depends on contributions from people just like you. The documentation was designed to allow anybody to recommend and add changes as necessary. Before you do, there are some guidelines that you should follow:
- Be succinct. People are looking for answers quickly and don't want to read large blocks of text to get to the answer.
- You can submit plain text (paragraphs), it will be html formatted automatically
- Chunk your content. Break up your content to make it easier to scan. Use sub-sections, code blocks, lists, and tables appropriately.
- Wrap inline code with <code> tags. Don't use quotes around the code. For example, "The <code>
$uses</code> variable specifies which models to use." - Wrap code blocks with <pre> tags. For example:
<pre> $this->functionName(); $this->otherFunctionName(); </pre>It's no longer necessary to escape pre contents
- File and URL paths should be wrapped in <kbd> tags.
- Use example.com when a generic domain name needs to be referenced. Its purpose is to be generic and will never be linked to a spam or porn site.
- Links to other resources in the book should be without the domain. Eg. /view/181/built-in-helpers
- Code examples should conform to CakePHP Coding Standards.
- Use predefined classes method, warning and note.
- And finally: Check the preview! If it doesn't look right to you - it won't look right when it's reviewed.
Ver comentários dessa seção
