external/og-aws
1
0
Fork 0
mirror of https://github.com/nickpoida/og-aws.git synced 2025-02-15 03:11:57 +00:00
Code Issues Releases Wiki Activity

Updates from review.

Browse source
This commit is contained in:
Joshua Levy 2016-10-12 23:13:59 -07:00
parent 0e2ffa182f
commit bcdf4e9a05
1 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
CONTRIBUTING.md
View file

@ -3,31 +3,31 @@ 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](/AUTHORS.md) all contributors. Here are few notes before you jump in. 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](/AUTHORS.md) all contributors. Here are few notes before you jump in.
[![Slack Chat](https://img.shields.io/badge/Chat-Slack-ff69b4.svg "Join us. Anyone is welcome!")](https://og-aws.slack.lexikon.io/) [![Ask a Question](https://img.shields.io/badge/%3f-Ask%20a%20Question-dc9d47.svg "Questions help improve the Guide")](https://airtable.com/shrXZ61VrovWfXYBg) [![Slack Chat](https://img.shields.io/badge/Chat-Slack-ff69b4.svg "Join us. Anyone is welcome!")](https://og-aws.slack.lexikon.io/) [![Ask a Question](https://img.shields.io/badge/%3f-Ask%20a%20Question-dc9d47.svg "Questions help improve the Guide")](https://airtable.com
/shrXZ61VrovWfXYBg)
### Please Help ### Please Help
If you’ve found this guide useful, you have many ways to help: If you’ve found this guide useful, you have many ways to help:
- The simplest thing you can do to contribute is [**join the Slack channel**](https://og-aws.slack.lexikon.io/) or [**add to our list of common questions**](https://airtable.com/shrXZ61VrovWfXYBg), which helps the community and guides what contributors can focus on. We encourage you to ask AWS questions and help others! - The simplest thing you can do to contribute is [**join the Slack channel**](https://og-aws.slack.lexikon.io/) or [**add to our list of common questions**](https://airtable.com/shrXZ61VrovWfXYBg), which helps the community and guides what contributors can focus on. We encourage you to ask AWS questions and help others!
- [**File issues**](https://github.com/open-guides/og-aws/issues) if it’s clear something needs to be improved and you’re not able to make a pull request. - [**File issues**](https://github.com/open-guides/og-aws/issues) if it’s clear something needs to be improved and you’re not able to make a pull request.
- [**Pull requests**](https://github.com/open-guides/og-aws/pulls) with changes are always welcome. Please keep them small and focused, so we can add items individually, and review the conventions below. If you want to make a larger change, try to discuss it in Slack. - [**Pull requests**](https://github.com/open-guides/og-aws/pulls) with changes are always welcome. Please keep them small and focused, so we can add items individually, and review the conventions below. If you want to make a larger change, try to discuss it in Slack.
- [**Review**] or [**comment**] on existing issues and pull requests if you have expertise. - **Review** or **comment** on existing issues and pull requests if you have expertise.
- If you have deep expertise, consider offering to be an **editor** or **expert**. Editors and experts are assigned roles that [help us review the guide](#editorial-process). Join Slack to discuss this. - If you have deep expertise, we may ask you to be an **editor** or **expert**. Editors and experts are assigned roles that [help us review](#editorial-process) the Guide. Join Slack to discuss this.
### Pull Request Etiquette ### Pull Request Etiquette
- Keep changes as small as is practical. Do not make changes to multiple sections at once, alter whitespace in broad ways, etc. - Keep changes as small as is practical. Do not make changes to multiple sections at once, alter whitespace in broad ways, etc.
- Neutrality: If you have an affiliation related to what you are changing, please disclose it. - Neutrality: If you have an affiliation related to what you are changing, please disclose it.
- Please do your best to review current issues and pull requests to avoid duplication. - Please do your best to review current issues and pull requests to avoid duplication.
### Writing Style ### Writing Style
- **Link to references:** If you are adding an item, whenever possible, try to add a link or reference to relevant discussion or reference pages. - **Link to references:** If you are adding an item, whenever possible, try to add a link or reference to relevant discussion or reference pages.
- **Be brief:** Avoid long expository paragraphs; it’s better to link to a blog. (We are open to linking to your own blog, if it’s the best source.) - **Be brief:** Avoid long expository paragraphs; it’s better to link to a blog. (We are open to linking to your own blog, if it’s the best source.)
- **Include opinions and common practice:** Thoughtful opinion is helpful. If there are multiple conventions or ideas on something held by experts, mention the different ones. - **Include opinions and common practice:** Thoughtful opinion is helpful. If there are multiple conventions or ideas on something held by experts, mention the different ones.
- **Clarity:** Strive for consistency with conventions listed here, but clarity is most important. - **Clarity:** Strive for consistency with conventions listed here, but clarity is most important.
### Writing Conventions ### Writing Conventions
@ -49,23 +49,23 @@ When you contribute, keep in mind these conventions:
- *X Alternatives and Lock-In*: Should you be using this service or something else? Is the decision an important one that locks you in? - *X Alternatives and Lock-In*: Should you be using this service or something else? Is the decision an important one that locks you in?
- *X Tips*: Everything you should know about the service, from big stuff to details. - *X Tips*: Everything you should know about the service, from big stuff to details.
- *X Gotchas and Limitations*: Common problems, large and small, as well as misconceptions and quirks. - *X Gotchas and Limitations*: Common problems, large and small, as well as misconceptions and quirks.
- Not all sections need to follow the above conventions exactly. - Not all sections need to follow the above conventions exactly.
- Note we try to make sections uniquely titled, so GitHub links to Markdown section anchors don’t collide and are stable. - Note we try to make sections uniquely titled, so GitHub links to Markdown section anchors don’t collide and are stable.
Note we keep consistent formatting in Markdown via [markdownfmt](https://github.com/shurcooL/markdownfmt). We run **admin/reformat.sh** to do this, but you don’t have to worry about it unless you really want to. Note we keep consistent formatting in Markdown via [markdownfmt](https://github.com/shurcooL/markdownfmt). We run **admin/reformat.sh** to do this, but you don’t have to worry about it unless you really want to.
### Editorial Process ### Editorial Process
- Roles: - Roles:
- **project leads:** General direction of process and overall quality of the Guide - **Project leads:** Own general direction of process and overall quality of the Guide.
- **editors:** Contributors own specific sections or aspects of the guide, usually by topic/section, reviewing PRs and contributing; requires expert knowledge - **Editors:** Contributors own specific sections or aspects of the Guide, reviewing PRs and/or writing. requires expert knowledge.
- **experts:** People with expert knowledge in various areas, who have agreed to review or help on demand with tougher questions or PRs - **Experts:** People with expert knowledge in various areas, who have agreed to review or help on demand with tougher questions or PRs.
- **contributors:** Everyone who helps one way or another - **Contributors:** Everyone who helps one way or another.
- All PRs are reviewed by an **editor** and for non-trivial changes, a **project lead**, usually in that order, but it can be reversed for expediency. - All PRs are reviewed by an **editor** and for non-trivial changes, a **project lead**, usually in that order, but it can be reversed for expediency.
- In addition, anyone with relevant knowledge is encouraged to review/comment on PRs - In addition, anyone with relevant knowledge is encouraged to review/comment on PRs.
- Both editors and project leads are responsible for checking for style or problems - Both editors and project leads are responsible for checking for style or problems.
- Trivial changes may me merged in directly by project leads or editors - Trivial changes may be merged in directly by project leads or editors.
### Contact ### Contact
If you have concerns or additional ideas of ways to help, contact [@jlevy](https://github.com/jlevy) (e-mail or DM on Slack). If you have concerns or additional ideas of ways to help, e-mail **og-aws@lexikon.io** or use Slack to contact the [project leads](AUTHORS.md).