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 and setup git-flow
$ git clone https://github.com/<username>/Entitas-CSharp.git
$ cd Entitas-CSharp
$ git branch master origin/master
$ git flow init -d
Open Entitas.sln and run the Tests project to ensure everything works as expected. Alternatively run the test script
$ ./Scripts/test
Use the policy.mdpolicy to make sure to conform to the given code style.
If you plan to make changes to the Entitas.Unity project, run
$ ./Scripts/update
This will copy all required Entitas source files to the Entitas.Unity project's Library folder. Entitas must be considered as a dependency. Any changes to Entitas source code within the Library folder in the Entitas.Unity project won't be committed and will be overwritten when running update again. Changes to Entitas must be done in the Entitas.sln project.
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. 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.