Merge pull request #26 from jgwerner/master

contrib and code of conduct

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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]. 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,100 @@
+# Contributing Guidelines
+
+Interested in making a contribution? Great! Just read through this guide and you should be good to go! If you have any questions or concerns, feel free to reach out to us in our Slack [community channel](https://slackin-tkscnxhpky.now.sh/).
+
+## TOC
+
+- [Forks](#forks)
+- [Commit Messages](#commit-messages)
+- [Issues](#issues)
+- [Contribution tips and guidelines](#contribution-tips-and-guidelines)
+
+## Forks
+
+We encourage the use of forks, even for our core maintainers. The following steps describe the procedure to create a new fork and contribute back to the upstream repo:
+
+1. Fork `https://github.com/3blades/openresty` repository to your user organization.
+1. Clone your copy of `https://github.com/your-username/openresty` onto your machine using
+`git clone https://github.com/your-username/openresty`.
+1. Specify a new remote upstream repository that will be synced with the fork: `git remote add upstream https://github.com/3blades/openresty`.
+1. Verify correct `upstream` configuration: `git remote -v`
+1. Fetch the branches and their respective commits from the upstream repository. Commits to master will be stored in a local branch, `upstream/master`.
+1. Checkout your fork's local `feature` or `fix` branch: `git checkout my-fix-or-feature-branch`.
+1. Make the necessary changes in your `my-fix-or-feature-branch` branch. .
+1. Merge the changes from your local `my-fix-or-feature-branch` branch with `upstream/master`, ensuring that your local changes are in sync with upstream master branch: `git merge upstream/master`.
+1. Submit a pull request to `https://github.com/3blades/openresty` and await review.
+
+## Commit Messages
+
+Commit messages in `notifications-server` start with a prefix that coincides with an issue `label`, then `/`, then `iss[#]`, such as `fix/iss3`. It's possible that an issue for the problem you are trying to solve does not exist, in that case, please help us open one. Even little things like typos in a document are worth documenting. Labels listed below:
+
+- `fix`: If the commit is working towards a bug fix.
+- `feature`: If the commit is working towards a new feature.
+- `chore`: If the commit was a chore, like updating a dependency or updating Travis.
+- `doc`: If the commit is a change to documentation.
+- `test`: If the commit contains a change to the test suite.
+
+## Issues
+
+When reporting issues:
+
+- Include the steps required to reproduce the problem. This information will help us review and fix your issue faster.
+- If applicable, include stack trace.
+- Big log files are best viewed in gist (https://gist.github.com). Make sure your gist is public.
+- Log files may have sensitive information, please remove this information if at all possible.
+
+## Quick contribution tips and guidelines
+
+This section gives contributors some guidelines.
+
+### We welcome all pull requests
+
+Developing a fix or new feature, however small, takes time. So thank you! Even the smallest corrections or enhancements matter, and we will do everything possible to process them in a timely manner. We will also make sure you get credit for your contributions.
+
+### Design and cleanup proposals
+
+We are constantly cleaning code and re factoring, and understand there is almost always a better way to do things. If so, let us know! We love new perspectives, particularly when it helps improve the underlying product.
+
+### Talking to other 3Blades users and contributors
+
+We primarily use our Slack community channel to communicate with 3Blades users and contributors. You can sign up for a free account [here](https://slackin-tkscnxhpky.now.sh/).
+
+### Conventions and Coding Style
+
+Submit unit tests with your changes. We primarily use [nosetests](http://nose.readthedocs.io/en/latest/usage.html) for Python, [jest](https://facebook.github.io/jest/) for React and [testing](https://golang.org/pkg/testing/) for Golang.
+
+Update the documentation when creating or modifying features. Test your
+documentation changes for clarity, concision, and correctness, as well as a
+clean documentation build. We base our style guide on the [AP Stylebook](https://en.wikipedia.org/wiki/AP_Stylebook).
+
+For coding style, we base ourselves on:
+
+- [AriBnb style guide](https://github.com/3blades/javascript) for JavaScript
+- [PEP8](https://www.python.org/dev/peps/pep-0008/) for Python
+- [Effective Go](https://golang.org/doc/effective_go.html) for Golang
+
+The PR should trigger automated style checks.
+
+### Merge approval
+
+The master branch needs to be as healthy as possible. We will do our best to merge code and documentation quickly, but need to balance that with sanity checks.
+
+Maintainers may use LGTM (Looks Good To Me) for documents and comments to
+indicate acceptance.
+
+### Sign your work
+
+Our projects are open source and we need to do everything possible to keep it that way. By signing, you certify that you wrote the code or that you have the right to send it our way. We use the [developer certificate of origin](http://developercertificate.org/) text to certify contributions.
+
+Every completed PR must have a signature before we can merge:
+
+    Signed-off-by: Joe Smith <[email protected]>
+
+Please use your real name.
+
+If you set your `user.name` and `user.email` git configs, you can sign your
+commit automatically with `git commit -s`.
+
+## 3Blades community guidelines
+
+Refer to our [Code of Conduct](CODE_OF_CONDUCT.md) for specifics. It is based on the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4.