Merge docs

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Tide Contributing Guide
+
+Before submitting your contribution, please make sure to take a moment and read through the following guidelines.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Tide Code of Conduct](https://github.com/xwp/go-tide/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
+
+## Issue Reporting Guidelines
+
+- The Issue list of this repo is **exclusively** for bug reports and feature requests.
+- Try to search for your issue, it may have already been answered or even fixed in the `develop` branch.
+- Check if the issue is reproducible with the latest stable version. If you are using a pre-release, please indicate the specific version you are using.
+- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues without clear reproducible steps will be closed immediately.
+- If your issue is resolved but still open, don't hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.
+
+## Pull Request Guidelines
+
+- Checkout a topic branch from `develop` and merge back against `develop`.
+    - If you are not familiar with branching please read [_A successful Git branching model_](http://nvie.com/posts/a-successful-git-branching-model/) before you go any further.
+- If adding a new feature:
+    - Add accompanying test case.
+    - Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it green-lit before working on it.
+- If fixing a bug:
+    - Provide detailed description of the bug in the PR. Live demo preferred.
+    - Add appropriate test coverage if applicable.
+
+Travis CI will run the unit tests whenever you push changes to your PR. Tests are required to pass successfully for a merge to be considered.

ISSUE_TEMPLATE.md

@@ -0,0 +1,27 @@
+<!--
+
+Have you read Tide's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/xwp/go-tide/blob/master/CODE_OF_CONDUCT.md
+
+Do you want to ask a question? Are you looking for support? The #tide channel in WordPress Slack is the best place for getting support: https://make.wordpress.org/chat/
+
+-->
+
+### Description
+
+[Description of the issue]
+
+### Steps to Reproduce
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+**Expected behavior:** [What you expect to happen]
+
+**Actual behavior:** [What actually happens]
+
+**Reproduces how often:** [What percentage of the time does it reproduce?]
+
+### Additional Information
+
+Any additional information, configuration or data that might be necessary to reproduce the issue.

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,42 @@
+### Requirements
+
+* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
+* All new code requires tests to ensure against regressions.
+
+### Description of the Change
+
+<!--
+
+We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
+
+-->
+
+### Alternate Designs
+
+<!-- Explain what other alternates were considered and why the proposed version was selected. -->
+
+### Benefits
+
+<!-- What benefits will be realized by the code change? -->
+
+### Possible Drawbacks
+
+<!-- What are the possible side-effects or negative impacts of the code change? -->
+
+### Verification Process
+
+<!--
+
+What process did you follow to verify that your change has the desired effects?
+
+- How did you verify that all new functionality works as expected?
+- How did you verify that all changed functionality works as expected?
+- How did you verify that the change has not introduced any regressions?
+
+Describe the actions you performed (e.g., commands you ran, text you typed, buttons you clicked) and describe the results you observed.
+
+-->
+
+### Applicable Issues
+
+<!-- Enter any applicable Issues here -->

README.md

@@ -1,16 +1,40 @@
-# GO Tide
-
 [![Build Status](https://travis-ci.org/xwp/go-tide.svg?branch=develop)](https://travis-ci.org/xwp/go-tide) [![Coverage Status](https://coveralls.io/repos/github/xwp/go-tide/badge.svg?branch=develop)](https://coveralls.io/github/xwp/go-tide?branch=develop) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-
-## Common Prerequisites
+> A rising tide lifts all boats.
+> -- United States President, John F. Kennedy (borrowed from the New England Council)
+
+An automated tool to provide insight into WordPress code and highlight areas to improve the quality of plugins and themes.
+
+We believe the web can be better. With Tide, the code which underpins every website can be more standardized, faster, and more secure. Tide is focused on WordPress, because no other platform has as large an impact on the state of the web. Tide raises the quality of code one plugin or theme at a time, by elevating the importance of code quality in the developer consciousness. **Because a rising Tide lifts all boats.**
+
+## [Table of Contents](#table-of-contents)
+   + [Introduction](#introduction)
+   + [Dependencies](#dependencies)
+   + [Setup]($setup)
+   + [API](#api)
+   + [Contributing](#contributing)
+   + [Contact Us](#contact-us)
+   + [Credits](#credits)
+   + [License](#license)
+
+### Introduction
+Tide services are responsible for the following:
+- The API is responsible for implementing a web server and REST API.
+- The Sync Server polls the WordPress.org API's for themes and plugins 
+to process and writes them to a queue.
+- The PHPCS Server reads messages from a queue and runs reports against 
+both plugins and themes, then sends the results back to the Tide API.
+- The Lighthouse Server reads messages from a queue and runs Google Lighthouse 
+reports against the themes only, then sends the results back to the Tide API.
+
+### Dependencies
 
 * Install [Composer][composer]
 * Create a new Cloud Project using the [Cloud Console][cloud-console]
 * Enable Billing on that project
 * [Enable Cloud SQL API][cloud-sql-api-enable]
 * Install [Google Cloud SDK][gcloud-sdk]
 
-## Project preparation
+### Setup
 
 Copy the `.env.dist` file to `.env`.
 
@@ -49,7 +73,7 @@ click 'Create' to create and download the JSON service account key to your
 local machine. Save it as `service-account.json` in the `service/api` directory 
 for use with connecting with both Cloud Storage and Cloud SQL.
 
-## API Setup
+### API
 
 First generate the API templates:
 
@@ -86,12 +110,20 @@ again. Be sure to stop the API with `make down` and then start it again with
 
 Note: Running `make down` will stop all Docker services.
 
-## Props
+### Contributing
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+### Contact Us
+Have questions? Don't open an Issue, come join us in the [`#tide` channel](https://wordpress.slack.com/messages/C7TK8FBUJ/) in [WordPress Slack](https://make.wordpress.org/chat/). Even though Slack is a chat service, sometimes it takes several hours for community members to respond — please be patient.
+
+### Credits
+Props: [@danlouw](https://github.com/danlouw), [@jeffpaul](https://github.com/jeffpaul), [@rheinardkorf](https://github.com/rheinardkorf), [@valendesigns](https://github.com/valendesigns)
 
-[@rheinardkorf](https://github.com/rheinardkorf), [@valendesigns](https://github.com/valendesigns)
+### License
+Tide utilizes an [MIT license](https://github.com/xwp/go-tide/blob/master/LICENSE).
 
 [composer]: https://getcomposer.org/
 [cloud-console]: https://console.cloud.google.com/
 [cloud-sql-api-enable]: https://console.cloud.google.com/flows/enableapi?apiid=sqladmin
 [gcloud-sdk]: https://cloud.google.com/sdk/
-[credentials-section]: https://console.cloud.google.com/apis/credentials/
+[credentials-section]: https://console.cloud.google.com/apis/credentials/