Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1.95 KB
Raw

Contributing to FantasyCrescendo

Submitting a pull request (Code assets)

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-branch-name
  3. Download and install the Unity Engine/Editor if you haven't already.
  4. Open the project in Unity.
  5. Make your change, add tests, and make sure the tests still pass
  6. Push to your fork and submit a pull request
  7. Pat your self on the back and wait for your pull request to be reviewed.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Update documentation as necessary.
  • 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.

Submitting to the Open Mailbox (Non-Code Assets)

  1. ZIP up/compress the files you would like submit towards the project.
  2. If the files collectively are less than 15MB in size, email the ZIPed files to [email protected]
  3. If the files are larger than 15MB, please instead upload them to a file sharing service like MediaFire, and send the link instead.
  4. In the email subject, be sure to tag it with "[Open Mailbox]".
  5. In the body of the email, please list all of the individuals that worked on the submitted material, this is for the sake of keeping track of who to credit. Those listed in these emails will be added to the CREDITS list.

Resources