Skip to main content

Contribution Guidelines

Tilli development team would like to thank you for your interest to contribute! We would love your input! We want to make contributing to this project as easy and transparent as possible, whether you are a developer or an organization or individual who wants to:

  • Pull Requests
  • Report Bugs & Issues
  • Provide Feedback
  • Propose New Features
  • Submit a Fix
  • Discuss the current state of the code
  • Become a Maintainer
  • Become a Translator
  • Contribute via Designs
  • Get involved with the Tilli community

We have created guidelines for contributing to Tilli project and packages. These are guidelines, not rules. We encourage you to use your best judgment, and feel free to recommend changes to this document in a pull request. We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull Requests:​

The best way to contribute to this project is by making a pull request in following ways:

  • Fork the Tilli project and work on your fork
  • Create a new branch on which you want to make changes - “git checkout -b ‘my-contribution’” or push your changes on develop branch
  • Please make one pull request per issue to avoid large merges.
  • Commit your change with a commit message describing the correction.
  • Submit a pull request against the Tilli repository.
  • In general, all pull requests must:
    • Have a clear use case, fix a demonstrable bug or serve the greater good of the project
    • Have unit tests, where appropriate;
    • Follow code style guidelines
    • Not break the existing test suite
    • Where bugs are fixed, where possible, there should be unit tests demonstrating the bug and also proving the fix. This helps prevent regression.
    • Change relevant comments and documentation when the behavior of code changes.

Report Bugs, Issues or Share Feedback​

If you find any bug and you're not sure how to fix it, or you don't know how to do a pull request, then you can create an Issue. Filing an Issue will help us see the problem and fix it. Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information. A contributor is invited to create an issue, discuss it, and provide a fix if needed. You are also welcome to share your feedback on any of the same.

GitHub Forms​

Kindly go to the respective repositories if you wish to file an issue/bugs, feedback, clarify doubts or propose a new feature through our GitHub forms:

For Backend Server​

If you encounter any issue or you are not able to figure out the same in the Backend Server, kindly report the issue on our official GitHub Forms:

  • Bug Report Form: HERE
  • Feedback/Doubts Form: HERE

You can also search for past issues or requests to check if any other user has already encountered your issue or suggested the same feature here:

  • For open issues (yet to be solved): HERE
  • For closed issues (solved): HERE

If you wish to open an issue that does not fall in any of the above categories, kindly open a blank issue: HERE

For IDE​

If you encounter any issue or you are not able to figure out the same in the IDE, kindly report the issue on our official GitHub Forms:

  • Bug Report Form: HERE
  • Feedback/Doubts Form: HERE

If you wish to suggest new features that could be beneficial for you and the community in the IDE kindly fill the following form:

  • Feature Request Form: HERE

You can also search for past issues or requests to check if any other user has already encountered your issue or suggested the same feature here:

  • For open issues (yet to be solved): HERE
  • For closed issues (solved): HERE

If you wish to open an issue that does not fall in any of the above categories, kindly open a blank issue: HERE

For Web-App​

If you encounter any issue or you are not able to figure out the same in the Web-App, kindly report the issue on our official GitHub Forms:

  • Bug Report Form: HERE
  • Feedback/Doubts Form: HERE

You can also search for past issues or requests to check if any other user has already encountered your issue or suggested the same feature here:

  • For open issues (yet to be solved): HERE
  • For closed issues (solved): HERE

If you wish to open an issue that does not fall in any of the above categories, kindly open a blank issue: HERE

For Godot Strategies​

If you encounter any issue or you are not able to figure out the same in the Godot Startegies, kindly report the issue on our official GitHub Forms:

  • Bug Report Form: HERE
  • Feedback/Doubts Form: HERE

You can also search for past issues or requests to check if any other user has already encountered your issue or suggested the same feature here:

  • For open issues (yet to be solved): HERE
  • For closed issues (solved): HERE

If you wish to open an issue that does not fall in any of the above categories, kindly open a blank issue: HERE

For Tilli-Machine-Learning Component​

If you encounter any issue or you are not able to figure out the same regarding the Machine Learning Component, kindly report the issue on our official GitHub Forms:

  • Bug Report Form: HERE
  • Feedback/Doubts Form: HERE

You can also search for past issues or requests to check if any other user has already encountered your issue or suggested the same feature here:

  • For open issues (yet to be solved): HERE
  • For closed issues (solved): HERE

If you wish to open an issue that does not fall in any of the above categories, kindly open a blank issue: HERE

Module-Creators​

If you encounter any issue or you are not able to figure out the same in the IDE, kindly report the issue on our official GitHub Forms:

  • Bug Report Form: HERE
  • Feedback/Doubts Form: HERE

If you wish to suggest new features that could be beneficial for you and the community in the IDE kindly fill the following form:

  • Feature Request Form: HERE

You can also search for past issues or requests to check if any other user has already encountered your issue or suggested the same feature here:

  • For open issues (yet to be solved): HERE
  • For closed issues (solved): HERE

If you wish to open an issue that does not fall in any of the above categories, kindly open a blank issue: HERE

Parents-Teachers​

If you encounter any issue and you are not able to figure out the same in the Web-App, kindly report the issue on our official GitHub Forms:

  • Bug Report Form: HERE
  • Feedback/Doubts Form: HERE

You can also search for past issues or requests to check if any other user has already encountered your issue or suggested the same feature here:

  • For open issues (yet to be solved): HERE
  • For closed issues (solved): HERE

If you wish to open an issue that does not fall in any of the above categories, kindly open a blank issue: HERE

Contribute via Translations:​

Kindly go to the User Documentation section on the left and read the Translator section to know more on how to contribute as a translator to support the Tilli community or write to us at info@tillikids.org

Contribute via Designs:​

If you are interested in creating and designing in games, UI/UX, animations, photos, infographics, tutorials, and explainers for the Tilli community -- feel free to contact us at info@tillikids.org

For any doubts with regard to development, whether it is to become a maintainer or to discuss the current state of the code, kindly reach out to support@teqbahn.com.

For any doubts with regard to design or content kindly reach out to info@tillikids.org

Style Guide​

This repository uses eslint to enforce air-bnb coding styles.

Last updated : 20/02/2023