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
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,29 +2,31 @@
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
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
23
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
24
26
25
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:
26
28
27
-
* 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.
28
30
* Licenses live in the `/_licenses` folder.
29
31
* The license files should be in the format of `_licenses/[lowercased-spdx-id].txt` (e.g., `_licenses/mit.txt`)
30
32
* Each license has both [required and optional metadata](https://github.com/github/choosealicense.com#license-metadata) that should be included.
@@ -43,8 +45,6 @@ find it in the GitHub repository. Then click the `Edit` button. Make your
43
45
changes, type in a commit message, and click the `Propose File Change` button.
44
46
That’s it!
45
47
46
-
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.
47
-
48
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).
Copy file name to clipboardExpand all lines: README.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Like a Choose Your Own Adventure site, but only much less interesting.
8
8
9
9
A lot of repositories on GitHub.com don't have a license. GitHub provides a license chooser, but if you don't know anything about licenses, how are you supposed to make an informed decision?
10
10
11
-
[ChooseALicense.com](http://www.choosealicense.com"Choose A Licence website") is designed to help people make an informed decision about licenses by demystifying license choices through non-judgmental guidance.
11
+
[ChooseALicense.com](https://www.choosealicense.com"Choose A Licence website") is designed to help people make an informed decision about licenses by demystifying license choices through non-judgmental guidance.
12
12
13
13
## Immediate Goals
14
14
@@ -39,8 +39,8 @@ Licenses sit in the `/_licenses` folder. Each license has YAML front matter desc
39
39
40
40
#### Required fields
41
41
42
-
*`title` - The license full name specified by http://spdx.org/licenses/
43
-
*`spdx-id` - Short identifier specified by http://spdx.org/licenses/
42
+
*`title` - The license full name specified by https://spdx.org/licenses/
43
+
*`spdx-id` - Short identifier specified by https://spdx.org/licenses/
44
44
*`source` - The URL to the license source text
45
45
*`description` - A human-readable description of the license
46
46
*`how` - Instructions on how to implement the license
@@ -52,7 +52,7 @@ Licenses sit in the `/_licenses` folder. Each license has YAML front matter desc
52
52
#### Optional fields
53
53
54
54
*`featured` - Whether the license should be featured on the main page (defaults to false)
55
-
*`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)
55
+
*`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)
56
56
*`nickname` - Customary short name if applicable (e.g, GPLv3)
57
57
*`note` - Additional information about the licenses
58
58
*`redirect_from` - Relative path(s) to redirect to the license from, to prevent breaking old URLs
@@ -69,6 +69,7 @@ The licenses on choosealicense.com are regularly imported to GitHub.com to be us
69
69
*`project` - The repository name
70
70
*`description` - The description of the repository
71
71
*`year` - The current year
72
+
*`projecturl` - The repository URL or other project website
72
73
73
74
## License properties
74
75
@@ -103,4 +104,4 @@ The license properties (rules) are stored as a bulleted list within the licenses
103
104
104
105
## License
105
106
106
-
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).
107
+
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
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
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/
9
+
description: Short identifier specified by https://spdx.org/licenses/
10
10
required: true
11
11
12
12
- name: source
@@ -44,7 +44,7 @@
44
44
required: false
45
45
46
46
- name: hidden
47
-
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)
<pclass="note"><strong>Optional: </strong> Add <strong><code>{{ page.spdx-id }}</code>{% if xgpl %}+{% endif %}</strong>{% if xgpl %} (or <strong><code>{{ page.spdx-id }}</code></strong> to disallow future versions){% endif %} to your project's package description, if applicable (e.g., <ahref="https://docs.npmjs.com/files/package.json#license">Node.js</a>, <ahref="http://guides.rubygems.org/specification-reference/#license=">Ruby</a>, and <ahref="http://doc.crates.io/manifest.html#package-metadata">Rust</a>). This will ensure the license is displayed in package directories.</p>
17
+
<pclass="note"><strong>Optional: </strong> Add <strong><code>{{ page.spdx-id }}{% if xgpl %}-or-later{% endif %}</code></strong>{% if xgpl %} (or <strong><code>{{ page.spdx-id }}-only</code></strong> to disallow future versions){% endif %} to your project's package description, if applicable (e.g., <ahref="https://docs.npmjs.com/files/package.json#license">Node.js</a>, <ahref="https://guides.rubygems.org/specification-reference/#license=">Ruby</a>, and <ahref="https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata">Rust</a>). This will ensure the license is displayed in package directories.</p>
0 commit comments