Skip to content

Commit 10170d7

Browse files
committed
Merge branch 'gh-pages' into goals
2 parents 6ba361d + fb331fd commit 10170d7

65 files changed

Lines changed: 1775 additions & 367 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.rubocop.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
AllCops:
2-
TargetRubyVersion: 2.1
2+
TargetRubyVersion: 2.4
33
Exclude:
44
- _site/**/*
55
- vendor/**/*
66

7+
Metrics/BlockLength:
8+
Enabled: false
9+
710
Metrics/LineLength:
811
Enabled: false
912

.travis.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@ script: "./script/cibuild"
55
#environment
66
language: ruby
77
rvm:
8-
- 2.3.3
8+
- 2.4.2
9+
10+
addons:
11+
apt:
12+
packages:
13+
- libcurl4-openssl-dev
914

1015
branches:
1116
only:

CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,36 @@
22

33
We love Pull Requests! Your contributions help make ChooseALicense.com great.
44

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+
57
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.
68

79
## Getting Started
810

911
So you want to contribute to ChooseALicense. Great! We welcome any help we can
1012
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.
1214

1315
## Adding a license
1416

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:
1618

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).
1820
2. The license must be listed on one of the following approved lists of licenses:
1921
* [List of OSI approved licenses](https://opensource.org/licenses/alphabetical)
2022
* [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)
2224
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
2326

2427
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:
2528

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.
2730
* Licenses live in the `/_licenses` folder.
2831
* The license files should be in the format of `_licenses/[lowercased-spdx-id].txt` (e.g., `_licenses/mit.txt`)
2932
* Each license has both [required and optional metadata](https://github.com/github/choosealicense.com#license-metadata) that should be included.
3033
* 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/
3135
* The body of the file should be the text of the license in plain text.
3236

3337
## Making Changes
@@ -41,8 +45,6 @@ find it in the GitHub repository. Then click the `Edit` button. Make your
4145
changes, type in a commit message, and click the `Propose File Change` button.
4246
That’s it!
4347

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-
4648
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).
4749

4850
## Testing

Gemfile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# frozen_string_literal: true
2+
13
source 'https://rubygems.org'
24

35
require 'json'
@@ -14,7 +16,7 @@ end
1416

1517
group :test do
1618
gem 'html-proofer', '~> 3.0'
17-
gem 'nokogiri'
19+
gem 'licensee'
1820
gem 'rake'
1921
gem 'rspec'
2022
gem 'rubocop'

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2013-2016 GitHub, Inc. and contributors
1+
Copyright (c) 2013-2018 GitHub, Inc. and contributors
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy
44
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 22 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,31 @@
11
**[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.
22

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).
4-
5-
The website navigation is
6-
7-
Collaborative
8-
9-
10-
[the CONTRIBUTING file](CONTRIBUTING.md#adding-a-license)
11-
12-
13-
## License
14-
15-
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).
16-
3+
[![Build Status](https://travis-ci.org/github/choosealicense.com.svg?branch=gh-pages)](https://travis-ci.org/github/choosealicense.com)
174

5+
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).
186

197
## License metadata
208

219
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:
2210

2311
#### Required fields
2412

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/
2715
* `source` - The URL to the license source text
2816
* `description` - A human-readable description of the license
2917
* `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`
3019
* `permissions` - Bulleted list of permission rules
3120
* `conditions` - Bulleted list of condition rules
3221
* `limitations` - Bulleted list of limitation rules
3322

3423
#### Optional fields
3524

3625
* `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)
3827
* `nickname` - Customary short name if applicable (e.g, GPLv3)
3928
* `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`
4129
* `redirect_from` - Relative path(s) to redirect to the license from, to prevent breaking old URLs
4230

4331
### Auto-populated fields
@@ -52,6 +40,7 @@ The licenses on choosealicense.com are regularly imported to GitHub.com to be us
5240
* `project` - The repository name
5341
* `description` - The description of the repository
5442
* `year` - The current year
43+
* `projecturl` - The repository URL or other project website
5544

5645
## License properties
5746

@@ -63,21 +52,27 @@ The license properties (rules) are stored as a bulleted list within the licenses
6352

6453
* `commercial-use` - This software and derivatives may be used for commercial purposes.
6554
* `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.
6958

7059
#### Conditions
7160

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.
7665
* `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.
7768

7869
#### Limitations
7970

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.
8172
* `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.
8374
* `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).

Rakefile

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# frozen_string_literal: true
2+
13
require 'html-proofer'
24
require 'rspec/core/rake_task'
35

@@ -13,7 +15,8 @@ task :test do
1315
HTMLProofer.check_directory('./_site',
1416
check_html: true,
1517
validation: { ignore_script_embeds: true },
16-
url_swap: { %r{http://choosealicense.com} => '' }).run
18+
url_swap: { %r{https://choosealicense.com} => '' },
19+
check_img_http: true).run
1720
end
1821

1922
task :approved_licenses do
@@ -24,7 +27,7 @@ task :approved_licenses do
2427
puts approved.join(', ')
2528
puts "\n"
2629

27-
potential = approved - licenses.map { |l| l['id'] }
30+
potential = approved - (licenses.map { |l| l['id'] })
2831
puts "#{potential.count} potential additions:"
2932
puts potential.join(', ')
3033
end

_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Choose a License
33
description: Non-judgmental guidance on choosing a license for your open source project
44
relative_permalinks: false
55
markdown: kramdown
6-
url: "http://choosealicense.com"
6+
url: "https://choosealicense.com"
77

88
collections:
99
licenses:
@@ -35,7 +35,7 @@ exclude:
3535
- assets/vendor/selectivizr/tests
3636
- assets/vendor/clipboard/test
3737

38-
gems:
38+
plugins:
3939
- jekyll-sitemap
4040
- jekyll-redirect-from
4141
- jekyll-seo-tag

_data/fields.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,6 @@
2121

2222
- name: year
2323
description: The current year
24+
25+
- name: projecturl
26+
description: The repository URL or other project website

_data/meta.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
# The available fields are:
33

44
- 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/
66
required: true
77

88
- 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
1111

1212
- name: source
1313
description: The URL to the license source text
@@ -33,14 +33,18 @@
3333
description: Bulleted list of limited rules
3434
required: true
3535

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+
3640
# Optional fields
3741

3842
- name: featured
3943
description: Whether the license should be featured on the main page (defaults to false)
4044
required: false
4145

4246
- 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)
4448
required: false
4549

4650
- name: nickname
@@ -51,10 +55,6 @@
5155
description: Additional information about the licenses
5256
required: false
5357

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-
5858
- name: redirect_from
5959
description: Relative path(s) to redirect to the license from, to prevent breaking old URLs
6060
required: false

0 commit comments

Comments
 (0)