Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chriscorcimiglia committed Mar 9, 2018
1 parent 3d398dd commit 1163794
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Contributing to SNAPS-Kubernetes

First off, thanks for taking the time to contribute! :+1:

## Code of Conduct

This project and everyone participating in it is governed by the
[SNAPS-Kubernetes Code of Conduct][1]. By participating, you are
expected to uphold this code. Please report unacceptable behavior to
[snaps@cablelabs.com][2].

[1]: CODE_OF_CONDUCT.md
[2]: mailto:snaps@cablelabs.com

## How Can I Contribute?

We're happy you want to contribute! You can help us in different ways:

- [Open an issue][3] with suggestions for improvements
- Fork this repository and submit a pull request
- Improve the [documentation][4] (same pull request flow)
- Join the conversation: [![IRC](https://www.irccloud.com/invite-svg?channel=%23cablelabs-snaps&hostname=irc.freenode.net&port=6697&ssl=1)][5]

[3]: https://github.com/cablelabs/snaps-kubernetes/issues
[4]: https://github.com/cablelabs/snaps-kubernetes/tree/master/doc
[5]: http://webchat.freenode.net/?channels=cablelabs-snaps

To submit a pull request, [fork][6] the [SNAPS-Kubernetes repository][7] and then
[clone][8] your fork:

```
git clone https://github.com/YOUR-GITHUB-USERNAME/snaps-kubernetes.git
```

[6]: https://help.github.com/articles/fork-a-repo/
[7]: https://github.com/cablelabs/snaps-kubernetes
[8]: https://help.github.com/articles/cloning-a-repository/

Make your suggested changes, `git commit`, `git push` and then [submit a pull request][9].

[9]: https://github.com/cablelabs/snaps-kubernetes/compare

Our [pull request template][13] should be used for all pull requests. If you're
creating your pull request from the GitHub site, then it will be automatically
populated with the template's contents, otherwise please copy and paste the
template text into your pull request.

[13]: PULL_REQUEST_TEMPLATE.md

## Resources

Some useful resources to get started:
- Project [README][10]
- [SNAPS-Kubernetes license][11]
- [SNAPS-Kubernetes install guide][12]

[10]: README.md
[11]: LICENSE
[12]: doc/source/install/install.md

0 comments on commit 1163794

Please sign in to comment.