Introduction paragraph – what does this guideline category address? A single paragraph of prose that implementors can understand. This paragraph should describe the intent and scope of the guideline. The title and this first paragraph should be used as the subject line and body of the commit message respectively.
Some notes about using this template:
Each file should be a group of related guidelines, such as “HTTP Headers” or similar. Each guideline gets its own subheader, and within each section there is an overview/introduction, a guidance section, examples, and references. Not every guideline will fill in every section. If a section isn’t needed for a particular guideline, delete it if you’re really sure it’s superfluous.
A detailed guideline that is being suggested. It should also have an introduction if applicable.
The actual guidance that the API working group would like to provide.
A series of examples that demonstrate the proper usage of the guideline being proposed. These examples may include, but are not limited to:
The examples should not include:
References may be provided in cases where they aid in giving a more complete understanding of the guideline. You are not required to have any references. Moreover, this guideline should still make sense when your references are unavailable. Examples of what you could include are:
RST supports footnotes in the following format: