You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,32 +2,36 @@
2
2
3
3
We love Pull Requests! Your contributions help make ChooseALicense.com great.
4
4
5
+
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.md).
6
+
5
7
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
6
8
7
9
## Getting Started
8
10
9
11
So you want to contribute to ChooseALicense. Great! We welcome any help we can
10
12
get. But first, please make sure you understand what
11
-
[this site is all about](http://choosealicense.com/about). It’s not a comprehensive list of all possible licenses.
13
+
[this site is all about](https://choosealicense.com/about). It’s not a comprehensive list of all possible licenses.
12
14
13
15
## Adding a license
14
16
15
-
Choosealicense.com is intended to demystify license choices, not present or catalog all of them. As such, only a small number are highlighted on the home page or <http://choosealicense.com/licenses>, and there are several requirements for a license to be [cataloged](http://choosealicense.com/appendix/) on the site:
17
+
Choosealicense.com is intended to demystify license choices, not present or catalog all of them. As such, only a small number are highlighted on the home page or <https://choosealicense.com/licenses>, and there are several requirements for a license to be [cataloged](https://choosealicense.com/appendix/) on the site:
16
18
17
-
1. The license must have [an SPDX identifier](https://spdx.org/licenses/). If your license isn't registered with SPDX, please [request that it be added](https://spdx.org/spdx-license-list/request-new-license-or-exception).
19
+
1. The license must have [an SPDX identifier](https://spdx.org/licenses/). If your license isn't registered with SPDX, please [request that it be added](https://spdx.org/spdx-license-list/request-new-license).
18
20
2. The license must be listed on one of the following approved lists of licenses:
19
21
*[List of OSI approved licenses](https://opensource.org/licenses/alphabetical)
20
22
*[GNU's list of free licenses](https://www.gnu.org/licenses/license-list.en.html) (*note: the license must be listed in one of the three "free" categories*)
21
-
*[Open Definition's list of conformant licenses](http://opendefinition.org/licenses/) (non-code)
23
+
*[Open Definition's list of conformant licenses](https://opendefinition.org/licenses/) (non-code)
22
24
3. A [GitHub code search](https://github.com/search?q=MIT+filename%3ALICENSE&type=Code) must reveal at least *1,000* public repositories using the license
25
+
4. Identification of 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that could be detected by [licensee](https://github.com/benbalter/licensee) if it knew about the license
23
26
24
27
If your proposed license meets the above criteria, here's a few other things to keep in mind as you propose the license's addition:
25
28
26
-
* Is the license already cataloged? See <http://choosealicense.com/appendix/> for a list of all of the licenses known by the site.
29
+
* Is the license already cataloged? See <https://choosealicense.com/appendix/> for a list of all of the licenses known by the site.
27
30
* Licenses live in the `/_licenses` folder.
28
31
* The license files should be in the format of `_licenses/[lowercased-spdx-id].txt` (e.g., `_licenses/mit.txt`)
29
32
* Each license has both [required and optional metadata](https://github.com/github/choosealicense.com#license-metadata) that should be included.
30
33
* The text of the license should be wrapped to a 78 character width.
34
+
* The text of the license should match the corresponding text found at https://spdx.org/licenses/
31
35
* The body of the file should be the text of the license in plain text.
32
36
33
37
## Making Changes
@@ -41,8 +45,6 @@ find it in the GitHub repository. Then click the `Edit` button. Make your
41
45
changes, type in a commit message, and click the `Propose File Change` button.
42
46
That’s it!
43
47
44
-
You will be asked to sign the [GitHub Contributor License Agreement](https://cla.github.com/) for this project when you make your first pull request.
45
-
46
48
For more advanced changes, check out [the bootstrap instructions](https://github.com/github/choosealicense.com#run-it-on-your-machine) in the [project's readme](/README.md).
**[ChooseALicense.com](http://choosealicense.com)** aims to provide **accurate**, **non-judgmental**, and **understandable** information about **open source licenses** in order to **help people make informed decisions** about the projects they start, maintain, contribute to, and use.
2
2
3
-
We catalog [select](CONTRIBUTING.md#adding-a-license) open source licenses with a [Jekyll collection](https://jekyllrb.com/docs/collections/) (in `_licenses`). The catalog is used to render [ChooseALicense.com](http://choosealicense.com) and is regularly vendored into [Licensee](https://github.com/benbalter/licensee), which GitHub uses to provide a [license chooser and license detection](https://help.github.com/articles/adding-a-license-to-a-repository/), a [licenses API](https://developer.github.com/v3/licenses/), and to [display license descriptions and metadata](https://github.com/blog/2335-open-source-license-descriptions-and-metadata).
The content of this project itself is licensed under the [Creative Commons Attribution 3.0 license](http://creativecommons.org/licenses/by/3.0/us/deed.en_US), and the underlying source code used to format and display that content is licensed under the [MIT license](http://opensource.org/licenses/mit-license.php).
We catalog [select](CONTRIBUTING.md#adding-a-license) open source licenses with a [Jekyll collection](https://jekyllrb.com/docs/collections/) (in `_licenses`). The catalog is used to render [ChooseALicense.com](http://choosealicense.com) and is regularly vendored into [Licensee](https://github.com/benbalter/licensee), which GitHub uses to provide a [license chooser and license detection](https://help.github.com/articles/adding-a-license-to-a-repository/), a [licenses API](https://developer.github.com/v3/licenses/), and to [display license descriptions and metadata](https://github.com/blog/2335-open-source-license-descriptions-and-metadata).
18
6
19
7
## License metadata
20
8
21
9
Licenses sit in the `/_licenses` folder. Each license has YAML front matter describing the license's properties. The body of the file contains the text of the license in plain text. The available metadata fields are:
22
10
23
11
#### Required fields
24
12
25
-
*`title` - The license full name specified by http://spdx.org/licenses/
26
-
*`spdx-id` - Short identifier specified by http://spdx.org/licenses/
13
+
*`title` - The license full name specified by https://spdx.org/licenses/
14
+
*`spdx-id` - Short identifier specified by https://spdx.org/licenses/
27
15
*`source` - The URL to the license source text
28
16
*`description` - A human-readable description of the license
29
17
*`how` - Instructions on how to implement the license
18
+
*`using` - A list of 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url`
30
19
*`permissions` - Bulleted list of permission rules
31
20
*`conditions` - Bulleted list of condition rules
32
21
*`limitations` - Bulleted list of limitation rules
33
22
34
23
#### Optional fields
35
24
36
25
*`featured` - Whether the license should be featured on the main page (defaults to false)
37
-
*`hidden` - Whether the license is neither [popular](https://opensource.org/licenses) nor fills out the [spectrum of licenses](http://choosealicense.com/licenses/) from strongly conditional to unconditional (defaults to true)
26
+
*`hidden` - Whether the license is neither [popular](https://opensource.org/licenses) nor fills out the [spectrum of licenses](https://choosealicense.com/licenses/) from strongly conditional to unconditional (defaults to true)
38
27
*`nickname` - Customary short name if applicable (e.g, GPLv3)
39
28
*`note` - Additional information about the licenses
40
-
*`using` - A list of up to 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url`
41
29
*`redirect_from` - Relative path(s) to redirect to the license from, to prevent breaking old URLs
42
30
43
31
### Auto-populated fields
@@ -52,6 +40,7 @@ The licenses on choosealicense.com are regularly imported to GitHub.com to be us
52
40
*`project` - The repository name
53
41
*`description` - The description of the repository
54
42
*`year` - The current year
43
+
*`projecturl` - The repository URL or other project website
55
44
56
45
## License properties
57
46
@@ -63,21 +52,27 @@ The license properties (rules) are stored as a bulleted list within the licenses
63
52
64
53
*`commercial-use` - This software and derivatives may be used for commercial purposes.
65
54
*`modifications` - This software may be modified.
66
-
*`distribution` - You may distribute this software.
67
-
*`private-use` - You may use and modify the software without distributing it.
68
-
*`patent-use` - This license provides an express grant of patent rights from the contributor to the recipient.
55
+
*`distribution` - This software may be distributed.
56
+
*`private-use` - This software may be used and modified in private.
57
+
*`patent-use` - This license provides an express grant of patent rights from contributors.
69
58
70
59
#### Conditions
71
60
72
-
*`include-copyright` - Include a copy of the license and copyright notice with the software.
73
-
*`document-changes` - Indicate changes made to the code.
74
-
*`disclose-source` - Source code must be made available when distributing the software.
75
-
*`network-use-disclose` - Users who interact with the software via network are given the right to receive a copy of the corresponding source code.
61
+
*`include-copyright` - A copy of the license and copyright notice must be included with the software.
62
+
*`document-changes` - Changes made to the code must be documented.
63
+
*`disclose-source` - Source code must be made available when the software is distributed.
64
+
*`network-use-disclose` - Users who interact with the software via network are given the right to receive a copy of the source code.
76
65
*`same-license` - Modifications must be released under the same license when distributing the software. In some cases a similar or related license may be used.
66
+
*`same-license--file` - Modifications of existing files must be released under the same license when distributing the software. In some cases a similar or related license may be used.
67
+
*`same-license--library` - Modifications must be released under the same license when distributing the software. In some cases a similar or related license may be used, or this condition may not apply to works that use the software as a library.
77
68
78
69
#### Limitations
79
70
80
-
*`trademark-use` - This license explicitly states that it does NOT grant you trademark rights, even though licenses without such a statement probably do not grant you any implicit trademark rights.
71
+
*`trademark-use` - This license explicitly states that it does NOT grant trademark rights, even though licenses without such a statement probably do not grant any implicit trademark rights.
81
72
*`liability` - This license includes a limitation of liability.
82
-
*`patent-use` - This license explicitly states that it does NOT grant you any rights in the patents of contributors.
73
+
*`patent-use` - This license explicitly states that it does NOT grant any rights in the patents of contributors.
83
74
*`warranty` - The license explicitly states that it does NOT provide any warranty.
75
+
76
+
## License
77
+
78
+
The content of this project itself is licensed under the [Creative Commons Attribution 3.0 license](https://creativecommons.org/licenses/by/3.0/us/deed.en_US), and the underlying source code used to format and display that content is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php).
Copy file name to clipboardExpand all lines: _data/meta.yml
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
# The available fields are:
3
3
4
4
- name: title
5
-
description: The license full name specified by http://spdx.org/licenses/
5
+
description: The license full name specified by https://spdx.org/licenses/
6
6
required: true
7
7
8
8
- name: spdx-id
9
-
description: Short identifier specified by http://spdx.org/licenses/
10
-
required: required
9
+
description: Short identifier specified by https://spdx.org/licenses/
10
+
required: true
11
11
12
12
- name: source
13
13
description: The URL to the license source text
@@ -33,14 +33,18 @@
33
33
description: Bulleted list of limited rules
34
34
required: true
35
35
36
+
- name: using
37
+
description: 'A list of 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url`'
38
+
required: true
39
+
36
40
# Optional fields
37
41
38
42
- name: featured
39
43
description: Whether the license should be featured on the main page (defaults to false)
40
44
required: false
41
45
42
46
- name: hidden
43
-
description: Whether the license is neither [popular](https://opensource.org/licenses) nor fills out the [spectrum of licenses](http://choosealicense.com/licenses/) from strongly conditional to unconditional (defaults to true)
47
+
description: Whether the license is neither [popular](https://opensource.org/licenses) nor fills out the [spectrum of licenses](https://choosealicense.com/licenses/) from strongly conditional to unconditional (defaults to true)
44
48
required: false
45
49
46
50
- name: nickname
@@ -51,10 +55,6 @@
51
55
description: Additional information about the licenses
52
56
required: false
53
57
54
-
- name: using
55
-
description: 'A list of up to 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url`'
56
-
required: false
57
-
58
58
- name: redirect_from
59
59
description: Relative path(s) to redirect to the license from, to prevent breaking old URLs
0 commit comments