The project is hosted on GitHub where you can report issues, fork the project and submit pull requests. Entitas is developed with TDD (Test Driven Development) and nspec. New features are introduced following the git-flow conventions.
Fork the repository on GitHub and clone your forked repository to your machine
$ git clone https://github.com/<username>/Entitas.git
If you want to contribute please consider to set up git-flow.
The default branch of this repository is master
$ cd Entitas
$ git branch master origin/master
$ git flow init -d
Open Entitas.sln and run the Tests project as a console application to ensure everything works as expected. Alternatively run the tests script
$ ./Scripts/bee tests
Create a new ticket to let people know what you're working on and to encourage a discussion. Follow the git-flow conventions and create a new feature branch starting with # and the issue number:
$ git flow feature start <#123-your-feature>
Write and update unit tests and make sure all the existing tests pass. To manually test your changes in a Unity project, run
$ ./Scripts/bee build
$ ./Scripts/bee sync
This will build Entitas with all your changes and copy all required assemblies to the Tests/Unity/VisualDebugging project's Library folder. You can open the Tests/Unity/VisualDebugging project in Unity and verify and test your changes manually. All changes to Entitas must be done in the Entitas.sln project.
If you have many commits please consider using git rebase to cleanup the commits. This can simplify reviewing the pull request.
Once you're happy with your changes open a pull request to your feature branch. The default branch is develop. Don't create a pull request from master.
By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch that your contributions are licensed under the Entitas license.
Thanks for your contributions and happy coding :)
Simon