Development Guidelines¶
This set of pages holds general guidelines and orientation for the development of software projects. All projects must follow all the rules from these guidelines.
Document Conventions¶
We use keywords like “MUST”, “MUST NOT”, “REQUIRED”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” with the same definitions as the RFC 2119.
Machine-readable text, such as code, URLs, protocols, etc are represented with
monospaced font (eg. HTTP method POST
). We use {}
to delimiter template
variables in samples and #
as a comment mark:
# This is a comment
https://api.example.com/account/{account-id}