mirror of
https://github.com/nickpoida/og-aws.git
synced 2025-02-13 02:12:02 +00:00
38 lines
2.7 KiB
Markdown
38 lines
2.7 KiB
Markdown
|
## Contributing
|
|||
|
|
|
|||
|
|
Contributions of all kinds, including discussion, corrections, additions, and improvements, are welcome!
|
|||
|
|
We hope you'll join and help, in small ways or large.
|
|||
|
|
We gladly credit all contributors and authors.
|
|||
|
|
Here are few notes before you jump in.
|
|||
|
|
|
|||
|
|
**Questions and discussion**:
|
|||
|
|
[File issues](https://github.com/open-guides/og-aws/issues) liberally! Don’t be shy about creating issues — they are the only way to discuss things here. Just tag it as a question or discussion. We or others can answer, and it may lead to improvements to the guide.
|
|||
|
|
|
|||
|
|
**Corrections and improvements**:
|
|||
|
|
[File issues](https://github.com/open-guides/og-aws/issues) describing the problem. Use them to discuss topics, ask questions, identify issues, or suggest improvements. [Pull requests](https://github.com/open-guides/og-aws/pulls) with changes are even better. Please keep them small and focused, so we can add items individually.
|
|||
|
|
|
|||
|
|
Of course, please review current issues and pull requests to avoid duplication.
|
|||
|
|
|
|||
|
|
Finally, if an issue isn't appropriate, please shoot an e-mail to [@jlevy](https://github.com/jlevy).
|
|||
|
|
|
|||
|
|
### Conventions
|
|||
|
|
|
|||
|
|
When you contribute, keep in mind these conventions:
|
|||
|
|
|
|||
|
|
* Terms that appear for the first time in **boldface** are defined there in a brief summary, with a link if possible to what is probably the best page for that concept.
|
|||
|
|
* References or citations backing some info that is already explained in the text is in [brackets] (with link for web pages, no link for books).
|
|||
|
|
* Related content that elaborates or gives more detail is included via inline links within the text.
|
|||
|
|
* Key and important statistics are **boldfaced **(illustrative numbers should not be).
|
|||
|
|
* References, including all references to books, are linked in brackets at the end of the bulleted entry.
|
|||
|
|
* Typographical conventions:
|
|||
|
|
* Prefer use of % for boldfaced statistics and ratios and prefer writing “percent” for interest rates.
|
|||
|
|
* Use Unicode open and close quotes “like this” and not "like this".
|
|||
|
|
* Use oriented apostrophes (Unicode’s, not ASCII's).
|
|||
|
|
* Use em dashes — like this (not two hyphens -- like this).
|
|||
|
|
* Section conventions: When appropriate please add sections covering these items:
|
|||
|
|
* *Basics*: The elementary facts you should know if you don't yet know anything about the service.
|
|||
|
|
* *Alternatives and Lock-In*: Should you be using this service or something else? Is the decision an important one that locks you in?
|
|||
|
|
* *Tips*: Everything you should know about the service, from big stuff to details.
|
|||
|
|
* *Cost Management*: Tips specific to that service on reducing or managing costs.
|
|||
|
|
* *Gotchas and Limitations*: Common problems, large and small, as well as misconceptions and quirks.
|