forked from openhab/org.openhab.binding.zigbee
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added license and contributing guidelines (openhab#17)
Signed-off-by: Kai Kreuzer <[email protected]>
- Loading branch information
1 parent
1be5623
commit 9af56c5
Showing
2 changed files
with
365 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,162 @@ | ||
## Contribution guidelines | ||
|
||
### Pull requests are always welcome | ||
|
||
We are always thrilled to receive pull requests, and do our best to | ||
process them as fast as possible. Not sure if that typo is worth a pull | ||
request? Do it! We will appreciate it. | ||
|
||
If your pull request is not accepted on the first try, don't be | ||
discouraged! If there's a problem with the implementation, hopefully you | ||
received feedback on what to improve. | ||
|
||
We're trying very hard to keep openHAB lean and focused. We don't want it | ||
to do everything for everybody. This means that we might decide against | ||
incorporating a new feature. However, there might be a way to implement | ||
that feature *on top of* openHAB. | ||
|
||
### Discuss your design on the mailing list | ||
|
||
We recommend discussing your plans [in the discussion forum](https://community.openhab.org/) | ||
before starting to code - especially for more ambitious contributions. | ||
This gives other contributors a chance to point you in the right | ||
direction, give feedback on your design, and maybe point out if someone | ||
else is working on the same thing. | ||
|
||
### Create issues... | ||
|
||
Any significant improvement should be documented as [a GitHub | ||
issue](https://github.com/openhab/org.openhab.binding.zigbee/issues?labels=enhancement&page=1&state=open) before anybody | ||
starts working on it. | ||
|
||
### ...but check for existing issues first! | ||
|
||
Please take a moment to check that an issue doesn't already exist | ||
documenting your bug report or improvement proposal. If it does, it | ||
never hurts to add a quick "+1" or "I have this problem too". This will | ||
help prioritize the most common problems and requests. | ||
|
||
### Conventions | ||
|
||
Fork the repo and make changes on your fork in a feature branch. | ||
|
||
Update the documentation when creating or modifying features. Test | ||
your documentation changes for clarity, concision, and correctness, as | ||
well as a clean documentation build. | ||
|
||
Write clean code. Universally formatted code promotes ease of writing, reading, | ||
and maintenance. | ||
|
||
Pull requests descriptions should be as clear as possible and include a | ||
reference to all the issues that they address. | ||
|
||
Pull requests must not contain commits from other users or branches. | ||
|
||
Commit messages must start with a capitalized and short summary (max. 50 | ||
chars) written in the imperative, followed by an optional, more detailed | ||
explanatory text which is separated from the summary by an empty line. | ||
|
||
Code review comments may be added to your pull request. Discuss, then make the | ||
suggested modifications and push additional commits to your feature branch. Be | ||
sure to post a comment after pushing. The new commits will show up in the pull | ||
request automatically, but the reviewers will not be notified unless you | ||
comment. | ||
|
||
Before the pull request is merged, make sure that you squash your commits into | ||
logical units of work using `git rebase -i` and `git push -f`. After every | ||
commit the test suite should be passing. Include documentation changes in the | ||
same commit so that a revert would remove all traces of the feature or fix. | ||
|
||
Commits that fix or close an issue should include a reference like `Closes #XXX` | ||
or `Fixes #XXX`, which will automatically close the issue when merged. | ||
|
||
### Merge approval | ||
|
||
openHAB maintainers use LGTM (Looks Good To Me) in comments on the code review | ||
to indicate acceptance. | ||
|
||
### Sign your work | ||
|
||
The sign-off is a simple line at the end of the explanation for the | ||
patch, which certifies that you wrote it or otherwise have the right to | ||
pass it on as an open-source patch. The rules are pretty simple: if you | ||
can certify the below (from | ||
[developercertificate.org](http://developercertificate.org/)): | ||
|
||
``` | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
660 York Street, Suite 102, | ||
San Francisco, CA 94110 USA | ||
Everyone is permitted to copy and distribute verbatim copies of this | ||
license document, but changing it is not allowed. | ||
Developer's Certificate of Origin 1.1 | ||
By making a contribution to this project, I certify that: | ||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; or | ||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. | ||
``` | ||
|
||
then you just add a line to every git commit message: | ||
|
||
Signed-off-by: Joe Smith <[email protected]> (github: github_handle) | ||
|
||
using your real name (sorry, no pseudonyms or anonymous contributions.) | ||
|
||
#### Small patch exception | ||
|
||
There are several exceptions to the signing requirement. Currently these are: | ||
|
||
* Your patch fixes spelling or grammar errors. | ||
* Your patch is a single line change to documentation. | ||
|
||
## Community Guidelines | ||
|
||
We want to keep the openHAB community awesome, growing and collaborative. We | ||
need your help to keep it that way. To help with this we've come up with some | ||
general guidelines for the community as a whole: | ||
|
||
* Be nice: Be courteous, respectful and polite to fellow community members: no | ||
regional, racial, gender, or other abuse will be tolerated. We like nice people | ||
way better than mean ones! | ||
|
||
* Encourage diversity and participation: Make everyone in our community | ||
feel welcome, regardless of their background and the extent of their | ||
contributions, and do everything possible to encourage participation in | ||
our community. | ||
|
||
* Keep it legal: Basically, don't get us in trouble. Share only content that | ||
you own, do not share private or sensitive information, and don't break the | ||
law. | ||
|
||
* Stay on topic: Make sure that you are posting to the correct channel | ||
and avoid off-topic discussions. Remember when you update an issue or | ||
respond to an email you are potentially sending to a large number of | ||
people. Please consider this before you update. Also remember that | ||
nobody likes spam. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,203 @@ | ||
Eclipse Public License - v 1.0 | ||
|
||
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC | ||
LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM | ||
CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. | ||
|
||
1. DEFINITIONS | ||
|
||
"Contribution" means: | ||
|
||
a) in the case of the initial Contributor, the initial code and documentation | ||
distributed under this Agreement, and | ||
b) in the case of each subsequent Contributor: | ||
i) changes to the Program, and | ||
ii) additions to the Program; | ||
|
||
where such changes and/or additions to the Program originate from and are | ||
distributed by that particular Contributor. A Contribution 'originates' | ||
from a Contributor if it was added to the Program by such Contributor | ||
itself or anyone acting on such Contributor's behalf. Contributions do not | ||
include additions to the Program which: (i) are separate modules of | ||
software distributed in conjunction with the Program under their own | ||
license agreement, and (ii) are not derivative works of the Program. | ||
|
||
"Contributor" means any person or entity that distributes the Program. | ||
|
||
"Licensed Patents" mean patent claims licensable by a Contributor which are | ||
necessarily infringed by the use or sale of its Contribution alone or when | ||
combined with the Program. | ||
|
||
"Program" means the Contributions distributed in accordance with this | ||
Agreement. | ||
|
||
"Recipient" means anyone who receives the Program under this Agreement, | ||
including all Contributors. | ||
|
||
2. GRANT OF RIGHTS | ||
a) Subject to the terms of this Agreement, each Contributor hereby grants | ||
Recipient a non-exclusive, worldwide, royalty-free copyright license to | ||
reproduce, prepare derivative works of, publicly display, publicly | ||
perform, distribute and sublicense the Contribution of such Contributor, | ||
if any, and such derivative works, in source code and object code form. | ||
b) Subject to the terms of this Agreement, each Contributor hereby grants | ||
Recipient a non-exclusive, worldwide, royalty-free patent license under | ||
Licensed Patents to make, use, sell, offer to sell, import and otherwise | ||
transfer the Contribution of such Contributor, if any, in source code and | ||
object code form. This patent license shall apply to the combination of | ||
the Contribution and the Program if, at the time the Contribution is | ||
added by the Contributor, such addition of the Contribution causes such | ||
combination to be covered by the Licensed Patents. The patent license | ||
shall not apply to any other combinations which include the Contribution. | ||
No hardware per se is licensed hereunder. | ||
c) Recipient understands that although each Contributor grants the licenses | ||
to its Contributions set forth herein, no assurances are provided by any | ||
Contributor that the Program does not infringe the patent or other | ||
intellectual property rights of any other entity. Each Contributor | ||
disclaims any liability to Recipient for claims brought by any other | ||
entity based on infringement of intellectual property rights or | ||
otherwise. As a condition to exercising the rights and licenses granted | ||
hereunder, each Recipient hereby assumes sole responsibility to secure | ||
any other intellectual property rights needed, if any. For example, if a | ||
third party patent license is required to allow Recipient to distribute | ||
the Program, it is Recipient's responsibility to acquire that license | ||
before distributing the Program. | ||
d) Each Contributor represents that to its knowledge it has sufficient | ||
copyright rights in its Contribution, if any, to grant the copyright | ||
license set forth in this Agreement. | ||
|
||
3. REQUIREMENTS | ||
|
||
A Contributor may choose to distribute the Program in object code form under | ||
its own license agreement, provided that: | ||
|
||
a) it complies with the terms and conditions of this Agreement; and | ||
b) its license agreement: | ||
i) effectively disclaims on behalf of all Contributors all warranties | ||
and conditions, express and implied, including warranties or | ||
conditions of title and non-infringement, and implied warranties or | ||
conditions of merchantability and fitness for a particular purpose; | ||
ii) effectively excludes on behalf of all Contributors all liability for | ||
damages, including direct, indirect, special, incidental and | ||
consequential damages, such as lost profits; | ||
iii) states that any provisions which differ from this Agreement are | ||
offered by that Contributor alone and not by any other party; and | ||
iv) states that source code for the Program is available from such | ||
Contributor, and informs licensees how to obtain it in a reasonable | ||
manner on or through a medium customarily used for software exchange. | ||
|
||
When the Program is made available in source code form: | ||
|
||
a) it must be made available under this Agreement; and | ||
b) a copy of this Agreement must be included with each copy of the Program. | ||
Contributors may not remove or alter any copyright notices contained | ||
within the Program. | ||
|
||
Each Contributor must identify itself as the originator of its Contribution, | ||
if | ||
any, in a manner that reasonably allows subsequent Recipients to identify the | ||
originator of the Contribution. | ||
|
||
4. COMMERCIAL DISTRIBUTION | ||
|
||
Commercial distributors of software may accept certain responsibilities with | ||
respect to end users, business partners and the like. While this license is | ||
intended to facilitate the commercial use of the Program, the Contributor who | ||
includes the Program in a commercial product offering should do so in a manner | ||
which does not create potential liability for other Contributors. Therefore, | ||
if a Contributor includes the Program in a commercial product offering, such | ||
Contributor ("Commercial Contributor") hereby agrees to defend and indemnify | ||
every other Contributor ("Indemnified Contributor") against any losses, | ||
damages and costs (collectively "Losses") arising from claims, lawsuits and | ||
other legal actions brought by a third party against the Indemnified | ||
Contributor to the extent caused by the acts or omissions of such Commercial | ||
Contributor in connection with its distribution of the Program in a commercial | ||
product offering. The obligations in this section do not apply to any claims | ||
or Losses relating to any actual or alleged intellectual property | ||
infringement. In order to qualify, an Indemnified Contributor must: | ||
a) promptly notify the Commercial Contributor in writing of such claim, and | ||
b) allow the Commercial Contributor to control, and cooperate with the | ||
Commercial Contributor in, the defense and any related settlement | ||
negotiations. The Indemnified Contributor may participate in any such claim at | ||
its own expense. | ||
|
||
For example, a Contributor might include the Program in a commercial product | ||
offering, Product X. That Contributor is then a Commercial Contributor. If | ||
that Commercial Contributor then makes performance claims, or offers | ||
warranties related to Product X, those performance claims and warranties are | ||
such Commercial Contributor's responsibility alone. Under this section, the | ||
Commercial Contributor would have to defend claims against the other | ||
Contributors related to those performance claims and warranties, and if a | ||
court requires any other Contributor to pay any damages as a result, the | ||
Commercial Contributor must pay those damages. | ||
|
||
5. NO WARRANTY | ||
|
||
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN | ||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR | ||
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, | ||
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each | ||
Recipient is solely responsible for determining the appropriateness of using | ||
and distributing the Program and assumes all risks associated with its | ||
exercise of rights under this Agreement , including but not limited to the | ||
risks and costs of program errors, compliance with applicable laws, damage to | ||
or loss of data, programs or equipment, and unavailability or interruption of | ||
operations. | ||
|
||
6. DISCLAIMER OF LIABILITY | ||
|
||
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY | ||
CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION | ||
LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE | ||
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY | ||
OF SUCH DAMAGES. | ||
|
||
7. GENERAL | ||
|
||
If any provision of this Agreement is invalid or unenforceable under | ||
applicable law, it shall not affect the validity or enforceability of the | ||
remainder of the terms of this Agreement, and without further action by the | ||
parties hereto, such provision shall be reformed to the minimum extent | ||
necessary to make such provision valid and enforceable. | ||
|
||
If Recipient institutes patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Program itself | ||
(excluding combinations of the Program with other software or hardware) | ||
infringes such Recipient's patent(s), then such Recipient's rights granted | ||
under Section 2(b) shall terminate as of the date such litigation is filed. | ||
|
||
All Recipient's rights under this Agreement shall terminate if it fails to | ||
comply with any of the material terms or conditions of this Agreement and does | ||
not cure such failure in a reasonable period of time after becoming aware of | ||
such noncompliance. If all Recipient's rights under this Agreement terminate, | ||
Recipient agrees to cease use and distribution of the Program as soon as | ||
reasonably practicable. However, Recipient's obligations under this Agreement | ||
and any licenses granted by Recipient relating to the Program shall continue | ||
and survive. | ||
|
||
Everyone is permitted to copy and distribute copies of this Agreement, but in | ||
order to avoid inconsistency the Agreement is copyrighted and may only be | ||
modified in the following manner. The Agreement Steward reserves the right to | ||
publish new versions (including revisions) of this Agreement from time to | ||
time. No one other than the Agreement Steward has the right to modify this | ||
Agreement. The Eclipse Foundation is the initial Agreement Steward. The | ||
Eclipse Foundation may assign the responsibility to serve as the Agreement | ||
Steward to a suitable separate entity. Each new version of the Agreement will | ||
be given a distinguishing version number. The Program (including | ||
Contributions) may always be distributed subject to the version of the | ||
Agreement under which it was received. In addition, after a new version of the | ||
Agreement is published, Contributor may elect to distribute the Program | ||
(including its Contributions) under the new version. Except as expressly | ||
stated in Sections 2(a) and 2(b) above, Recipient receives no rights or | ||
licenses to the intellectual property of any Contributor under this Agreement, | ||
whether expressly, by implication, estoppel or otherwise. All rights in the | ||
Program not expressly granted under this Agreement are reserved. | ||
|
||
This Agreement is governed by the laws of the State of New York and the | ||
intellectual property laws of the United States of America. No party to this | ||
Agreement will bring a legal action under this Agreement more than one year | ||
after the cause of action arose. Each party waives its rights to a jury trial in | ||
any resulting litigation. |