diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1f20d2b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# How to Contribute + +We love Pull Requests! Your contributions help make ChooseALicense.com great. + +## Getting Started + +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. + +If you understand the goals of this site and still want to suggest a change, +please: + +* Make sure you have a [GitHub account](https://github.com/signup/free) +* Submit a ticket for your issue, assuming one does not already exist. + * Clearly describe the issue including steps to reproduce when it is a bug. + * Make sure you fill in the earliest version that you know has the issue. + +## Making Changes + +The easiest way to make a change is to simply edit a file from your browser. +When you click the edit button, it will fork the repository under your account. +Note what issue/issues your patch fixes in the commit message. + +For example, to [change this file](https://github.com/github/choosealicense.com/blob/master/CONTRIBUTING.md), +find it in the GitHub repository. Then click the `Edit` button. Make your +changes, type in a commit message, and click the `Propose File Change` button. +That’s it! diff --git a/README.md b/README.md index 8567f7a..da920dc 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ licenses. * Politics Free - Let's just not get into it. * 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 license chooser similar to -the [creative commons license chooser](http://creativecommons.org/choose/) +* For the 1%, the site will contain a list of licenses common for specific +communities and situations. * Not comprehensive. Seems like an odd goal, but there are a bajillion (I counted) licenses out there. We're going to have to filter that down to a small list of those that matter.