Skip to content

Commit 7cb96b1

Browse files
Create CONTRIBUTING.md
1 parent 777e3d5 commit 7cb96b1

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

CONTRIBUTING.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<a href="https://luos.io"><img src="https://www.luos.io/wp-content/uploads/2020/03/Luos-color.png" alt="Luos logo" title="Luos" align="right" height="60" /></a>
2+
3+
# Contributing to Luos
4+
5+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
6+
7+
* Reporting a bug
8+
* Discussing the current state of the code
9+
* Submitting a fix
10+
* Proposing new features
11+
* Becoming a maintainer
12+
13+
## We Develop with Github
14+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
15+
16+
## Report bugs and requests using Github's issues
17+
We use GitHub issues to track public bugs and requests.
18+
Report a bug or a request by opening a new issue; it's that easy!
19+
20+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
21+
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
22+
23+
1. Fork the repo and create your branch from `master`.
24+
2. If you've added code that should be tested, add tests.
25+
3. If you've changed APIs, update the documentation.
26+
4. Ensure the test suite passes.
27+
5. Make sure your code lints.
28+
6. Issue that pull request!
29+
30+
## Any contributions to a driver and/or an application you make will be under the [MIT Software License](http://choosealicense.com/licenses/mit/)
31+
In short, when you submit code changes to drivers and apps, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
32+
33+
## Any contributions to Luos core technology you make will be under the [Luos License](https://github.com/Luos-io/Luos/blob/master/LICENSE.md)
34+
In short, when you submit code changes to Luos core technology, your submissions are understood to be under the [Luos License](https://github.com/Luos-io/Luos/blob/master/LICENSE.md) that covers the project. Feel free to contact the maintainers if that's a concern.
35+
36+
## Write bug reports with detail, background, and sample code
37+
Great Bug Reports tend to have:
38+
39+
* A quick summary and/or background
40+
* Steps to reproduce
41+
* Be specific!
42+
* Give sample code if you can
43+
* What you expected would happen
44+
* What actually happens
45+
* Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
46+
47+
People love thorough bug reports. I'm not even kidding.
48+
49+
## Don't hesitate to read [our documentation](https://docs.luos.io), or to post your questions/issues on the [Luos' Forum](https://community.luos.io). :books:
50+
51+
[![](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.luos.io&logo=Discourse)](https://community.luos.io)
52+
[![](https://img.shields.io/badge/Luos-Documentation-34A3B4)](https://docs.luos.io)
53+
[![](https://img.shields.io/badge/LinkedIn-Follow%20us-0077B5?style=flat&logo=linkedin)](https://www.linkedin.com/company/luos)

0 commit comments

Comments
 (0)