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.
Note: For large changes or added features, please open an Issue indicating what you are intended to work on. This is to allow greater collaboration and prevent multiple isolated indivduals accidentially working on the same thing.
- 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.
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.
- Target and make changes against the develop branch.