GitHub templates and docs improvements (#302)

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,21 @@
+<!--
+1. Please check if an issue already exists so there are no duplicates
+2. Check out and follow our Guidelines: https://github.com/serverless/event-gateway/blob/master/CONTRIBUTING.md
+3. Fill out the whole template so we have a good overview on the issue
+4. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the Issue
+5. Please follow the template, otherwise we'll have to ask you to update it
+-->
+
+## This is a [Bug Report/Feature Proposal]
+
+For bug reports, please answer following questions:
+* What went wrong?
+* What did you expect should have happened?
+* What was the version you used?
+* What stacktrace or error message did you see?
+
+For feature proposals, please answer following question:
+* What is the use case that should be solved? The more detail you describe this in the easier it is to understand for us.
+
+Similar or dependent issues:
+* #XXXXX

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,40 @@
+<!--
+1. Please check out and follow our Contributing Guidelines: https://github.com/serverless/event-gateway/blob/master/CONTRIBUTING.md
+2. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the PR
+3. Please follow the template, otherwise we'll have to ask you to update it and it will take longer until your PR is merged
+-->
+
+## What did you implement:
+
+Closes #XXXXX
+
+<!--
+Briefly describe the feature if no issue exists for this PR
+-->
+
+## How did you implement it:
+
+<!--
+If this is a nontrivial change please briefly describe your implementation so its easy for us to understand and review your code.
+-->
+
+## How can we verify it:
+
+<!--
+Add any applicable config, commands, screenshots or other resources
+to make it easy for us to verify this works. The easier you make it for us
+to review a PR, the faster we can review and merge it.
+-->
+
+## Todos:
+
+- [ ] Write tests
+- [ ] Write documentation
+- [ ] Fix linting errors
+- [ ] Make sure code coverage hasn't dropped
+- [ ] Provide verification commands / resources
+- [ ] Enable "Allow edits from maintainers" for this PR
+- [ ] Update the messages below
+
+***Is this ready for review?:*** NO
+***Is it a breaking change?:*** NO

CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# 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 our team at **hello@serverless.com**. As an alternative
+feel free to reach out to any of us personally. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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,53 @@
+# Contributing Guidelines
+
+Welcome, and thanks in advance for your help! Please follow these simple guidelines :+1:
+
+## Propose a New Feature or Bug Fix
+
+**Note:** Please make sure to write an issue first and get enough feedback before jumping into a Pull Request!
+
+- Please make sure there is an open issue discussing your contribution.
+- If there isn't, open an issue so we can talk about it before you invest time into the implementation.
+- When creating an issue follow the guide that GitHub shows so we have enough information about your proposal.
+
+## Working on an Existing Issue
+
+**Note:** Please write a quick comment in the corresponding issue and ask if the feature is still relevant and that you want to jump into the implementation.
+
+Check out our [help-wanted](https://github.com/serverless/event-gateway/labels/status%2Fhelp-wanted) or [easy-pick](https://github.com/serverless/event-gateway/labels/status%2Feasy-pick) labels to find issues we want to move forward on with your help.
+
+We will do our best to respond/review/merge your PR according to priority. We hope that you stay engaged with us during this period to insure QA. Please note that the PR will be closed if there hasn't been any activity for a long time (~ 30 days) to keep us focused and keep the repo clean.
+
+## Reviewing Pull Requests
+
+Another really useful way to contribute to the Event Gateway is to review other peoples Pull Requests. Having feedback from multiple people is really helpful and reduces the overall time to make a final decision about the Pull Request.
+
+## Writing / Improving Documentation
+
+Our documentation lives on GitHub in the [docs](docs) directory. Do you see a typo or other ways to improve it? Feel free to edit it and submit a Pull Request!
+
+## Providing Support
+
+The easiest thing you can do to help us move forward and make an impact on our progress is to simply provide support to other people having difficulties with their Serverless projects.
+
+You can do that by replying to [issues on Github](https://github.com/serverless/event-gateway/issues), chatting with other community members in [our Chat](http://chat.serverless.com) or helping with questions in [our Forum](http://forum.serverless.com).
+
+---
+
+# Code Style
+
+We use [gofmt](https://golang.org/cmd/gofmt/). Please format Golang files with this tool before submitting a PR.
+
+# Testing
+
+We aim for high test coverage, so make sure your tests cover as much of your code as possible.
+
+# Our Code of Conduct
+
+Finally, to make sure you have a pleasant experience while being in our welcoming community, please read our [code of conduct](CODE_OF_CONDUCT.md). It outlines our core values and believes and will make working together a happier experience.
+
+Thanks again for being a contributor to the Serverless Community :tada:!
+
+Cheers,
+
+The :zap: [Serverless](http://www.serverless.com) Team

README.md

@@ -41,13 +41,13 @@ Azure, Google & IBM.
 
 ## Quick Start
 
-The easiest way to get started with the Event Gateway is using the [Serverless framework](https://serverless.com). The
+The easiest way to get started with the Event Gateway is using the [Serverless Framework](https://serverless.com). The
 framework is setup to automatically download and install the Event Gateway during development of a serverless service.
 
-Check out **[event-gateway example app](https://github.com/serverless/event-gateway-example)** for a walkthrough of
-using the Event Gateway locally. 
+Check out **[Event Gateway Example Application](https://github.com/serverless/event-gateway-example)** for a walkthrough of
+using the Event Gateway locally.
 
-If you want to install and develop with the Event Gateway without the framework,
+If you want to install and develop with the Event Gateway without the Serverless Framework,
 [instructions can be found here](./docs/developing.md).
 
 ## Motivation
@@ -580,7 +580,7 @@ directly.
 │                                            │                    │                                              │
 │                                            │   ┌─────────────┐  │                                              │
 │                                            │   │             │  │                                              │
-│                   ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─│─ │etcd cluster │ ┼ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─                    │
+│                   ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─│─ ▶│etcd cluster │◀ ┼ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─                    │
 │                                            │   │             │  │                          │                   │
 │                   │                        │   └─────────────┘  │                                              │
 │                                            │          ▲         │                          │                   │
@@ -591,15 +591,15 @@ directly.
 │        │  ┌───────────────┐ │              │  ┌──────────────┐  │               │  ┌──────────────┐  │         │
 │        │  │               │ │              │  │              │  │               │  │              │  │         │
 │        │  │ Event Gateway │ │              │  │Event Gateway │  │               │  │Event Gateway │  │         │
-│        │  │   instance    │┼──────────┐   │  │   instance   │─┼──────────┐    │  │   instance   │  │         │
+│        │  │   instance    │◀┼──────────┐   │  │   instance   │◀─┼──────────┐    │  │   instance   │  │         │
 │        │  │               │ │          │   │  │              │  │          │    │  │              │  │         │
 │        │  └───────────────┘ │          │   │  └──────────────┘  │          │    │  └──────────────┘  │         │
 │        │          ▲         │          │   │          ▲         │          │    │          ▲         │         │
 │        │          │         │          │   │          │         │          │    │          │         │         │
 │        │          │         │          │   │          │         │          │    │          │         │         │
 │        │          ▼         │          │   │          ▼         │          │    │          ▼         │         │
 │        │        ┌───┐       │          │   │        ┌───┐       │          │    │        ┌───┐       │         │
-│        │        │ λ ├┐      │          └───┼───────│ λ ├┐      │          └────┼───────│ λ ├┐      │         │
+│        │        │ λ ├┐      │          └───┼───────▶│ λ ├┐      │          └────┼───────▶│ λ ├┐      │         │
 │        │        └┬──┘│      │              │        └┬──┘│      │               │        └┬──┘│      │         │
 │        │         └───┘      │              │         └───┘      │               │         └───┘      │         │
 │        └────────────────────┘              └────────────────────┘               └────────────────────┘         │

docs/developing.md

@@ -10,6 +10,13 @@ curl -sfL https://raw.githubusercontent.com/serverless/event-gateway/master/inst
 
 On Windows download [binary](https://github.com/serverless/event-gateway/releases).
 
+Alternatively, build a Docker image:
+
+```
+git clone git@github.com:serverless/event-gateway.git
+cd event-gateway
+docker build -t event-gateway .
+```
 
 ## Running Locally
 
@@ -19,6 +26,12 @@ Run `event-gateway` in `dev` mode:
 event-gateway -dev
 ```
 
+or
+
+```
+docker run -p 4000:4000 -p 4001:4001 event-gateway -dev
+```
+
 ### Register a Function
 
 Register an AWS Lambda function in the Function Discovery.