Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.83 KB

Contributing to Corona

To contribute code to Corona you will need to fork this repository, commit and push your changes to it and then create a Github pull request with your changes.

Then your changes will be reviewed and possibly accepted to the Corona and included in next daily build.

Note, that when submitting code to Corona you will have to accept the Contributor License Agreement (CLA). This is necessary due to nature of Corona's licensing model. In general terms, you are granting to Corona a copyright and a patent license on your contributed code, allowing Corona to use it for its projects. You will keep being the only owner of such copyright and patent. Copy of CLA can be found in CLA.md. You will be asked to sign CLA with your Github account when submitting each pull request.

Make sure you have rights to submitted code. Meaning you wrote it yourself. If code requires attribution, make sure to provide it.

General guidelines for contributing

If you design a new API or make changes to an existing one, remember thant tens of thousands of games and apps rely on the existing API design. Our API is a contract between Corona and it's users, we do not want to break it unless absolutely necessary. If you're designing a new API, try to follow existing naming conventions for names and parameters.

Make sure to test your changes, preferably on several platforms.

File headers

All source code files in Corona must have a header with some information and license. If you're adding a file, make sure to include header in it. File headers are available in FILE_HEADER.md.

Communication

Feel free to join our Slack #opensource channel or Forums to get more information on Corona code, tips how to get started and discussion.