Create CONTRIBUTING.md
This commit is contained in:
parent
18e9a93d33
commit
54e5bb327c
1 changed files with 23 additions and 0 deletions
23
CONTRIBUTING.md
Normal file
23
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# Contributing
|
||||
|
||||
Thank you for looking to contributed to Kompute. We welcome contributions of any type including:
|
||||
|
||||
- Reporting a bug
|
||||
- Adding tests
|
||||
- Submitting a fix
|
||||
- Proposing new features
|
||||
|
||||
## We Develop with Github
|
||||
|
||||
We use github to host code, to track issues and feature requests, as well as accept pull requests.
|
||||
|
||||
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
|
||||
|
||||
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
|
||||
|
||||
1. Fork the repo and create your branch from `master`.
|
||||
2. Add tests to maintain and/or increase code coverage.
|
||||
3. If you've changed APIs, update the documentation.
|
||||
4. Ensure the test suite passes.
|
||||
5. Make sure your code lints.
|
||||
6. Issue that pull request!
|
||||
Loading…
Add table
Add a link
Reference in a new issue