disambiguate support

This commit is contained in:
Ben Balter 2017-07-17 10:38:15 -04:00
parent 63b12fd035
commit 437b0754c2
No known key found for this signature in database
GPG Key ID: DBB67C246AD356C4
2 changed files with 17 additions and 0 deletions

View File

@ -2,6 +2,20 @@
Interested in contributing to Licensee? Wed love your help. Licensee is an open source project, built one contribution at a time by users like you.
## Reporting an improperly detected license
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.
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.
To check if Licensee itself can properly detect a license, please:
1. Clone the repository locally `git clone https://github.com/benbalter/licensee`
2. `script/bootstrap`
3. `script/git-repo [URL to your repository]`
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`.
## Adding a license
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).

3
docs/SUPPORT.md Normal file
View File

@ -0,0 +1,3 @@
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.
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.