An easy to use Unity 3D library for creating illustrated Interactive Fiction games and more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

32 lines
1.5 KiB

# Contributing
We welcome pull requests from everyone. By contributing to this project, you agree to abide by the Fungus [code of conduct]. You also agree that by submitting a pull request for this project, **[your contribution will be licensed under the MIT license for this project][fungus license]**.
Fork and clone the Fungus repo (see [fork a repo] )
Switch to the develop branch.
Make sure the tests pass locally (see the project readme for instructions).
Make your change. Add tests and/or demo scenes for your change. Make the tests pass locally.
Push to your fork and [submit a pull request][pr].
We will try to give initial feedback to pull requests within a few days. However, this may not always be possible. Please be patient, we will look at every pull request as soon as we can.
Your pull request will have a better chance of being accepted if you do the following:
* Send one pull request for each new feature. It's time consuming for us to review multi-feature changes.
* Write tests for each change / new feature (not always possible)
* Follow our [coding standard]
* Write a [good commit message][commit].
* Target and make changes against the develop branch.
[code of conduct]: https://github.com/snozbot/fungus/wiki/code_of_conduct
[commit]: http://chris.beams.io/posts/git-commit/
[fork a repo]: https://help.github.com/articles/fork-a-repo/
[fungus license]: https://github.com/FungusGames/Fungus/blob/master/LICENSE
[pr]: https://github.com/snozbot/fungus/compare
[coding standard]: https://github.com/snozbot/fungus/wiki/coding_standard