docs/choosealicense.com
docs/choosealicense.com
1
0
Fork 0
mirror of https://github.com/github/choosealicense.com synced 2024-12-22 12:50:24 +01:00
Code Issues Releases Wiki Activity

bullet point contributing instructions

Browse Source
This commit is contained in:
Ben Balter 2016-01-18 15:28:22 -05:00
parent 5e897e30b3
commit 42e559a962
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -8,7 +8,7 @@ So you want to contribute to ChooseALicense. Great! We welcome any help we can
get. But first, please make sure you understand what
[this site is all about](http://choosealicense.com/about). It’s not a comprehensive list of all possible licenses.
## Adding new licenses
## Adding a license
Choosealicense.com is intended to demystify license choices, not present all of them. As such, there are several requirements for a license to be listed on the site:
@ -19,7 +19,13 @@ Choosealicense.com is intended to demystify license choices, not present all of
* [Open Definition's list of conformant licenses](http://opendefinition.org/licenses/) (non-code)
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
If your proposed license meets the above criteria, please follow [these instructions for adding a new license](https://github.com/github/choosealicense.com#adding-a-license). Almost without exception, new licenses should be added as hidden (`hidden: true` in the YAML front matter), such that they are directly linkable and detectable, but not otherwise listed.
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:
* Licenses live in the `/_licenses` folder.
* Each license has both [required and optional metadata](https://github.com/github/choosealicense.com#license-metadata) that should be included.
* The text of the license should be wrapped to a 78 character width.
* The body of the file should be the text of the license in plain text.
* Almost without exception, new licenses should be added as hidden (`hidden: true` in the YAML front matter), such that they are directly linkable and detectable, but not otherwise listed.
## Making Changes

8
README.md
View File

@ -12,7 +12,7 @@ A lot of repositories on GitHub.com don't have a license. GitHub provides a lice
## Immediate Goals
* Non-judgemental. Our goal is to help you find a license that meets *your* goals.
* Non-judgmental. Our goal is to help you find a license that meets *your* goals.
* Well designed, but that goes without saying.
* The homepage should have just enough to help 99% of folks make a decision.
* For the 1%, the site will contain a list of licenses common to specific communities and situations.
@ -28,11 +28,9 @@ script/server
```
Open `http://localhost:4000` in your favorite browser.
## Adding a license
## License metadata
Licenses sit in the `/_licenses` folder. The text of the license should be wrapped to a 78 character width. Each license has YAML front matter describing the license's properties. The body of the file should be the text of the license in plain text. The available metadata fields are:
### YAML front matter
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:
#### Required fields