Skip to content

Commit

Permalink
Add MIT Licence and Contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
rogchap committed Apr 18, 2019
1 parent 760d19c commit 82be3e5
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 3 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,21 @@
# How to contribute

**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

## Guidelines for Pull Requests

How to get your contributions merged smoothly and quickly.

* Create **small PRs** that are narrowly focused on **addressing a single concern**. We often times receive PRs that are trying to fix several things at a time, but only one fix is considered acceptable, nothing gets merged and both author's & review's time is wasted. Create more PRs to address different concerns and everyone will be happy.

* For speculative changes, consider opening an issue and discussing it first.

* Provide a good **PR description** as a record of **what** change is being made and **why** it was made. Link to a github issue if it exists.

* Unless your PR is trivial, you should expect there will be reviewer comments that you'll need to address before merging. We expect you to be reasonably responsive to those comments, otherwise the PR will be closed after 2-3 weeks of inactivity.

* Maintain **clean commit history** and use **meaningful commit messages**. PRs with messy commit history are difficult to review and won't be merged. Use `rebase -i upstream/master` to curate your commit history and/or to bring in latest changes from master (but avoid rebasing in the middle of a code review).

* Keep your PR up to date with upstream/master (if there are merge conflicts, we can't really merge your change).

* Exceptions to the rules can be made if there's a compelling reason for doing so.
21 changes: 21 additions & 0 deletions LICENCE
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019-present SafetyCulture Pty Ltd. All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion README.md
@@ -1,6 +1,6 @@
# gRPC-Web Dev Tools

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

> Under Development
Expand Down
9 changes: 7 additions & 2 deletions package.json
@@ -1,7 +1,12 @@
{
"name": "grpc-web-devtools",
"version": "0.1.0",
"private": true,
"license": "MIT",
"author": "SafetyCulture",
"repository": {
"type": "git",
"url": "https://github.com/SafetyCulture/grpc-web-devtools"
},
"dependencies": {
"react": "^16.8.6",
"react-dom": "^16.8.6",
Expand All @@ -26,4 +31,4 @@
"not ie <= 11",
"not op_mini all"
]
}
}

0 comments on commit 82be3e5

Please sign in to comment.