First of all, thank you for considering contributing to Tonic IDE Core! We appreciate your effort and value your input. This document provides guidelines and instructions for contributing to the project.
By participating in this project, you are expected to uphold our Code of Conduct. Please read and understand the code before contributing.
There are several ways you can contribute to Tonic IDE Core:
- Report Bugs: If you find a bug, please create an issue in our issue tracker with the "bug" label. Include as much information as possible, such as steps to reproduce, expected behavior, and screenshots if applicable.
- Suggest Enhancements: If you have an idea for a new feature or enhancement, please create an issue in our issue tracker with the "enhancement" label. Provide a clear description of the feature and explain why it would be beneficial to the project.
- Contribute Code: If you would like to contribute to the upcoming release, please go through our backlog of features in our issue tracker with the "good-first-issue" label. You can contribute code by submitting a pull request. Before submitting a pull request, make sure to discuss the changes in a corresponding issue or create a new issue for the changes.
- Flutter Documentation
- Data Definition: Freezed
- State Management: Riverpod
- Local Storage: Isar
- Theme: Flex Color Scheme
- Routing: Go Router
- Localisation: ICU i18n syntax
- Language Server Protocol
- Ensure that your changes adhere to the project's coding standards and guidelines.
- Make sure your changes do not introduce new bugs or break existing functionality. Test your changes thoroughly.
- Commit your changes with a descriptive and concise commit message. Follow the conventional commit format.
- Create a pull request against the
mainbranch of the original repository. In the pull request description, provide a summary of your changes and reference any related issues. - Be prepared to address any feedback or requested changes from the maintainers.
By contributing to Tonic IDE Core, you agree that your contributions will be licensed under the project's LICENSE.
Once again, thank you for your interest in contributing to Tonic IDE Core! We look forward to collaborating with you and making this project even better.