external/og-aws
1
0
Fork 0
mirror of https://github.com/nickpoida/og-aws.git synced 2025-03-09 15:40:06 +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
Download patch file Download diff file Expand all files Collapse all files

24
CONTRIBUTING.md
View file

@ -3,7 +3,8 @@ 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.
[![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
@ -12,9 +13,8 @@ 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!
- [**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.
- [**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.
- **Review** or **comment** on existing issues and pull requests if you have expertise.
- 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
@ -57,15 +57,15 @@ Note we keep consistent formatting in Markdown via [markdownfmt](https://github.
### Editorial Process
- Roles:
- **project leads:** 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
- **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
- **Project leads:** Own general direction of process and overall quality of the Guide.
- **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.
- **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.
- 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
- Trivial changes may me merged in directly by project leads or editors
- 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.
- Trivial changes may be merged in directly by project leads or editors.
### 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).