mirror of https://github.com/lukechilds/umbrel.git
Mayank Chhabra
3 years ago
committed by
GitHub
3 changed files with 151 additions and 115 deletions
@ -0,0 +1,52 @@ |
|||
Contributing to Umbrel |
|||
====================== |
|||
|
|||
Umbrel is an open project and we love to receive contributions from our community! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Umbrel itself. |
|||
|
|||
Bug reports |
|||
----------- |
|||
|
|||
If you think you have found a bug in Umbrel, first make sure that you are on the [latest version of Umbrel](https://github.com/getumbrel/umbrel/releases/latest) because your issue may already have been fixed. If not, search our [issues list](https://github.com/getumbrel/umbrel/issues) on GitHub in case a similar issue has already been opened. |
|||
|
|||
If there's no existing issue, please open a new issue and provide us as much information about the bug as you can. It would be very helpful if you can list down the steps for us to reproduce the bug, because the easier it is for us to recreate the bug, the faster it is likely to be fixed. |
|||
|
|||
Feature requests |
|||
---------------- |
|||
|
|||
If you find yourself wishing for a feature that doesn't exist in Umbrel, you are probably not alone. There are bound to be others out there with similar needs. Please search our [issues list](https://github.com/getumbrel/umbrel/issues) on GitHub and our [community forum](https://community.getumbrel.com). If you can't find an existing feature request, please open a new topic on the [community forum](https://community.getumbrel.com) with your feature request. |
|||
|
|||
Contributing code and documentation changes |
|||
------------------------------------------- |
|||
|
|||
If you would like to contribute a new feature or a bugfix, please discuss your idea first on a GitHub issue. If there is no existing GitHub issue for your idea, please open one. There are often a number of ways to fix a problem and it is important to find the right approach before spending time on a PR that cannot be merged. So we request you to only start the work on implementing a feature once you received a green light from one of our maintainers on your idea and its implementation. |
|||
|
|||
We add the [help wanted](https://github.com/getumbrel/umbrel/labels/help%20wanted) label to existing GitHub issues for which community contributions are particularly welcome, and we use the [good first issue](https://github.com/getumbrel/umbrel/labels/good%20first%20issue) label to mark issues that we think will be suitable for new contributors. |
|||
|
|||
The process for contributing to any of the [Umbrel repositories](https://github.com/getumbrel/) is similar. |
|||
|
|||
### Contributor License |
|||
|
|||
By submitting your contribution, you agree that all of your present and past contributions to us are licensed from you under the MIT license (text below) and do not require us to include your copyright notice. However, if you want to be on our contributor list, please leave us a message [here](https://keybase.io/team/getumbrel). |
|||
|
|||
``` |
|||
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. |
|||
``` |
@ -1,149 +1,133 @@ |
|||
>Umbrel is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. |
|||
> |
|||
>You should have received a copy of the license along with this work. If not, see [here](https://creativecommons.org/licenses/by-nc-nd/4.0/). |
|||
> Umbrel is licensed under the PolyForm Noncommercial License 1.0.0. Please refer to our [License FAQ](https://github.com/getumbrel/umbrel/wiki/License-FAQ) if you have any questions or reach out to us directly at help@getumbrel.com. |
|||
|
|||
## Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International Public License |
|||
# PolyForm Noncommercial License 1.0.0 |
|||
|
|||
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. |
|||
<https://polyformproject.org/licenses/noncommercial/1.0.0> |
|||
|
|||
### Section 1 – Definitions. |
|||
## Acceptance |
|||
|
|||
a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. |
|||
In order to get any license under these terms, you must agree |
|||
to them as both strict obligations and conditions to all |
|||
your licenses. |
|||
|
|||
b. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. |
|||
## Copyright License |
|||
|
|||
e. __Effective Technological Measures__ means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. |
|||
The licensor grants you a copyright license for the |
|||
software to do everything you might do with the software |
|||
that would otherwise infringe the licensor's copyright |
|||
in it for any permitted purpose. However, you may |
|||
only distribute the software according to [Distribution |
|||
License](#distribution-license) and make changes or new works |
|||
based on the software according to [Changes and New Works |
|||
License](#changes-and-new-works-license). |
|||
|
|||
f. __Exceptions and Limitations__ means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. |
|||
## Distribution License |
|||
|
|||
h. __Licensed Material__ means the artistic or literary work, database, or other material to which the Licensor applied this Public License. |
|||
The licensor grants you an additional copyright license |
|||
to distribute copies of the software. Your license |
|||
to distribute covers distributing the software with |
|||
changes and new works permitted by [Changes and New Works |
|||
License](#changes-and-new-works-license). |
|||
|
|||
i. __Licensed Rights__ means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. |
|||
## Notices |
|||
|
|||
h. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License. |
|||
You must ensure that anyone who gets a copy of any part of |
|||
the software from you also gets a copy of these terms or the |
|||
URL for them above, as well as copies of any plain-text lines |
|||
beginning with `Required Notice:` that the licensor provided |
|||
with the software. For example: |
|||
|
|||
i. __NonCommercial__ means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital file-sharing or similar means is NonCommercial provided there is no payment of monetary compensation in connection with the exchange. |
|||
> Required Notice: Copyright Yoyodyne, Inc. (http://example.com) |
|||
|
|||
j. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. |
|||
## Changes and New Works License |
|||
|
|||
k. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. |
|||
The licensor grants you an additional copyright license to |
|||
make changes and new works based on the software for any |
|||
permitted purpose. |
|||
|
|||
l. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. |
|||
## Patent License |
|||
|
|||
### Section 2 – Scope. |
|||
The licensor grants you a patent license for the software that |
|||
covers patent claims the licensor can license, or becomes able |
|||
to license, that you would infringe by using the software. |
|||
|
|||
a. ___License grant.___ |
|||
## Noncommercial Purposes |
|||
|
|||
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: |
|||
Any noncommercial purpose is a permitted purpose. |
|||
|
|||
A. reproduce and Share the Licensed Material, in whole or in part, for NonCommercial purposes only; and |
|||
## Personal Uses |
|||
|
|||
B. produce and reproduce, but not Share, Adapted Material for NonCommercial purposes only. |
|||
Personal use for research, experiment, and testing for |
|||
the benefit of public knowledge, personal study, private |
|||
entertainment, hobby projects, amateur pursuits, or religious |
|||
observance, without any anticipated commercial application, |
|||
is use for a permitted purpose. |
|||
|
|||
2. __Exceptions and Limitations.__ For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. |
|||
## Noncommercial Organizations |
|||
|
|||
3. __Term.__ The term of this Public License is specified in Section 6(a). |
|||
Use by any charitable organization, educational institution, |
|||
public research organization, public safety or health |
|||
organization, environmental protection organization, |
|||
or government institution is use for a permitted purpose |
|||
regardless of the source of funding or obligations resulting |
|||
from the funding. |
|||
|
|||
4. __Media and formats; technical modifications allowed.__ The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. |
|||
## Fair Use |
|||
|
|||
5. __Downstream recipients.__ |
|||
You may have "fair use" rights for the software under the |
|||
law. These terms do not limit them. |
|||
|
|||
A. __Offer from the Licensor – Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. |
|||
## No Other Rights |
|||
|
|||
B. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. |
|||
These terms do not allow you to sublicense or transfer any of |
|||
your licenses to anyone else, or prevent the licensor from |
|||
granting licenses to anyone else. These terms do not imply |
|||
any other licenses. |
|||
|
|||
6. __No endorsement.__ Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). |
|||
## Patent Defense |
|||
|
|||
b. ___Other rights.___ |
|||
If you make any written claim that the software infringes or |
|||
contributes to infringement of any patent, your patent license |
|||
for the software granted under these terms ends immediately. If |
|||
your company makes such a claim, your patent license ends |
|||
immediately for work on behalf of your company. |
|||
|
|||
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. |
|||
## Violations |
|||
|
|||
2. Patent and trademark rights are not licensed under this Public License. |
|||
The first time you are notified in writing that you have |
|||
violated any of these terms, or done anything with the software |
|||
not covered by your licenses, your licenses can nonetheless |
|||
continue if you come into full compliance with these terms, |
|||
and take practical steps to correct past violations, within |
|||
32 days of receiving notice. Otherwise, all your licenses |
|||
end immediately. |
|||
|
|||
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties, including when the Licensed Material is used other than for NonCommercial purposes. |
|||
## No Liability |
|||
|
|||
### Section 3 – License Conditions. |
|||
***As far as the law allows, the software comes as is, without |
|||
any warranty or condition, and the licensor will not be liable |
|||
to you for any damages arising out of these terms or the use |
|||
or nature of the software, under any kind of legal claim.*** |
|||
|
|||
Your exercise of the Licensed Rights is expressly made subject to the following conditions. |
|||
## Definitions |
|||
|
|||
a. ___Attribution.___ |
|||
The **licensor** is the individual or entity offering these |
|||
terms, and the **software** is the software the licensor makes |
|||
available under these terms. |
|||
|
|||
1. If You Share the Licensed Material, You must: |
|||
**You** refers to the individual or entity agreeing to these |
|||
terms. |
|||
|
|||
A. retain the following if it is supplied by the Licensor with the Licensed Material: |
|||
**Your company** is any legal entity, sole proprietorship, |
|||
or other kind of organization that you work for, plus all |
|||
organizations that have control over, are under the control of, |
|||
or are under common control with that organization. **Control** |
|||
means ownership of substantially all the assets of an entity, |
|||
or the power to direct its management and policies by vote, |
|||
contract, or otherwise. Control can be direct or indirect. |
|||
|
|||
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); |
|||
**Your licenses** are all the licenses granted to you for the |
|||
software under these terms. |
|||
|
|||
ii. a copyright notice; |
|||
|
|||
iii. a notice that refers to this Public License; |
|||
|
|||
iv. a notice that refers to the disclaimer of warranties; |
|||
|
|||
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; |
|||
|
|||
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and |
|||
|
|||
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. |
|||
|
|||
For the avoidance of doubt, You do not have permission under this Public License to Share Adapted Material. |
|||
|
|||
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. |
|||
|
|||
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. |
|||
|
|||
### Section 4 – Sui Generis Database Rights. |
|||
|
|||
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: |
|||
|
|||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes only and provided You do not Share Adapted Material; |
|||
|
|||
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and |
|||
|
|||
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. |
|||
|
|||
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. |
|||
|
|||
### Section 5 – Disclaimer of Warranties and Limitation of Liability. |
|||
|
|||
a. __Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.__ |
|||
|
|||
b. __To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.__ |
|||
|
|||
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. |
|||
|
|||
### Section 6 – Term and Termination. |
|||
|
|||
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. |
|||
|
|||
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: |
|||
|
|||
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or |
|||
|
|||
2. upon express reinstatement by the Licensor. |
|||
|
|||
For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. |
|||
|
|||
c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. |
|||
|
|||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. |
|||
|
|||
### Section 7 – Other Terms and Conditions. |
|||
|
|||
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. |
|||
|
|||
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. |
|||
|
|||
### Section 8 – Interpretation. |
|||
|
|||
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. |
|||
|
|||
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. |
|||
|
|||
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. |
|||
|
|||
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. |
|||
|
|||
> Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. |
|||
> |
|||
> Creative Commons may be contacted at [creativecommons.org](http://creativecommons.org). |
|||
**Use** means anything you do with the software requiring one |
|||
of your licenses. |
|||
|
Loading…
Reference in new issue