Skip to content

Commit

Permalink
Add contributions guide
Browse files Browse the repository at this point in the history
  • Loading branch information
alexellis committed May 4, 2017
1 parent 116705f commit 4023a3f
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,19 @@
## Contributing

### License

This project is licensed under the MIT License.

## Guidelines

Here are a few guidelines for contributing:

* If you have found a bug please raise an issue and fill out the whole template.
* If you would like to contribute to the codebase please raise an issue to propose the change and fill out the whole template.
* If the documentation can be improved / translated etc please raise an issue to discuss. PRs for changing one or two typos aren't necessary.

**Practical stuff**

* Please sign your commits with `git commit -s` so that commits are traceable.
* Please always provide a summary of what you changed, how you did it and how it can be tested

22 changes: 22 additions & 0 deletions LICENSE
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2016-2017 Alex Ellis

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.

7 changes: 7 additions & 0 deletions README.md
Expand Up @@ -86,6 +86,13 @@ $ curl --data-binary @README.md http://localhost:8080/function/hello-function
$ uname -a | curl http://localhost:8080/function/hello-function --data-binary @-
```

### License and contributing

This project is part of the FaaS project licensed under the MIT License.

For more details see the [Contributing guide](https://github.com/alexellis/faas-cli/blob/master/CONTRIBUTING.md).


### Installation / pre-requirements

* Docker
Expand Down

0 comments on commit 4023a3f

Please sign in to comment.