Skip to content

Commit e181f73

Browse files
committed
Update docs/CONTRIBUTING.md
1 parent b2e9160 commit e181f73

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,29 @@ Feature requests are welcome. But take a moment to find out whether your idea fi
3535

3636
[Open an issue](https://github.com/licensee/licensee/issues/new) which describes the feature you would like to see, why you want it, how it should work, etc.
3737

38+
## Reporting an improperly detected license
39+
40+
Licensee is an open source project used by hosted services like GitHub and GitLab which often detect licenses using prior versions of Licensee and cache the result.
41+
42+
If you'd like to report that a license is improperly detected by a hosted service, please contact [GitHub support](https://github.com/contact) or [GitLab support](https://about.gitlab.com/getting-help/) directly.
43+
44+
To check if Licensee itself can properly detect a license, please:
45+
46+
1. Clone the repository locally `git clone https://github.com/benbalter/licensee`
47+
2. `script/bootstrap`
48+
3. `script/git-repo [URL to your repository]`
49+
50+
If Licensee cannot detect the license locally, [open an issue](https://github.com/benbalter/licensee/issues/new) and include the output of `script/git-repo`.
51+
52+
## Adding a license
53+
54+
Licensee doesn't curate any license information directly. Instead, we rely on the licenses and metadata provided by choosealicense.com and its much larger community (which can properly vet licenses and make determinations as to their properties).
55+
56+
Interested in adding support for Licensee to detect an additional license? Please [follow these instructions](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license) to submit a pull request to get the license added upstream, and it will be automatically vendored (and detected) here.
57+
58+
## Updating the licenses
59+
60+
License data is pulled from `choosealicense.com`. To update the license data, simple run `script/vendor-licenses`.
3861

3962

4063
## Your first contribution

0 commit comments

Comments
 (0)