-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Shamelessly stolen from https://github.com/thesecretlab/YarnSpinner/blob/master/CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Contributing to ggez | ||
|
||
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. | ||
|
||
## How to send in your contributions | ||
|
||
There are many ways you can send your contributions to ggez. You can either **report a bug**, or you can make the changes yourself and **submit a pull request**! | ||
|
||
### Reporting bugs and opening issues | ||
|
||
Please [report bugs](https://github.com/ggez/ggez/issues) and open issues generously. Don't be afraid that your idea is silly, or you're reporting a duplicate. We're happy to hear from you. Seriously. | ||
|
||
> ***Please Note:*** ggez is written by volunteers. If you encounter a problem while using it, we'll do our best to help you, but the authors cannot offer any support. | ||
### Submitting a pull request | ||
|
||
* [Fork](https://github.com/ggez/ggez/fork) and clone the repository | ||
* Create a new branch: git checkout -b my-branch-name | ||
* Make your changes | ||
* Push to your fork and [submit a pull request](https://github.com/ggez/ggez/compare) | ||
* Pat your self on the back and wait for your pull request to be reviewed. | ||
|
||
If you're unfamiliar with how pull requests work, [GitHub's documentation on them](https://help.github.com/articles/using-pull-requests/) is very good. | ||
|
||
Here are a few things you can do that will increase the likelihood of your pull request being accepted: | ||
|
||
* Update the documentation as necessary, as well as making code changes. | ||
* Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
* [Write a good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
||
### Branches | ||
|
||
All of ggez's in-progress work happens on the `master` branch. When we make a major release, we make a new branch for that release number, and only backwards-compatible changes get merged from `master` into it. | ||
|
||
For example, when we release `0.3.0`, it gets its own branch. If we then discover and fix a bug in `master`, we can merge the changes fixing that bug into the `0.3` branch, and make a `0.3.1` release from it. | ||
|
||
### Code and other contributions | ||
|
||
Contributions to ggez (via pull request or otherwise) must be licensed under the same license as ggez |