1
0
mirror of https://github.com/github/choosealicense.com synced 2024-06-09 12:47:49 +02:00
choosealicense.com/CONTRIBUTING.md

42 lines
1.6 KiB
Markdown
Raw Normal View History

2013-01-23 01:31:07 +01:00
# How to Contribute
We love Pull Requests! Your contributions help make ChooseALicense.com great.
## Getting Started
2013-10-30 18:10:25 +01:00
So you want to contribute to ChooseALicense. Great! We welcome any help we can
get. But first, please make sure you understand what
2013-01-23 01:31:07 +01:00
[this site is all about](http://choosealicense.com/about).
Its not a comprehensive list of all possible licenses.
2013-10-30 18:10:25 +01:00
If you understand the goals of this site and still want to suggest a change,
2013-01-23 01:31:07 +01:00
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
2013-10-30 18:10:25 +01:00
The easiest way to make a change is to simply edit a file from your browser.
2013-01-23 01:31:07 +01:00
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](/CONTRIBUTING.md),
2013-10-30 18:10:25 +01:00
find it in the GitHub repository. Then click the `Edit` button. Make your
2013-01-23 01:31:07 +01:00
changes, type in a commit message, and click the `Propose File Change` button.
Thats it!
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).
2013-10-23 09:07:51 +02:00
## Testing
[HTML::Proofer](https://github.com/gjtorikian/html-proofer) is set up to validate all links within the project. You can run this locally to ensure that your changes are valid:
```shell
./script/bootstrap
./script/cibuild
2013-10-23 09:07:51 +02:00
```