Thank you for your interest in improving Teebot Flow.
This project is open source and licensed under the GNU Affero General Public License v3.0. By contributing, you agree that your work will be distributed under the same license. This applies to the repository as a whole, including its existing commit history and all future contributions.
- Report bugs and suggest improvements by opening an issue.
- Propose new features or UX improvements.
- Submit pull requests for fixes, refactors, tests, or documentation.
- Improve translations, examples, or developer docs.
- Read the project overview in README.md.
- Review the architecture notes in docs/database-architecture.md.
- Follow the code of conduct in CODE_OF_CONDUCT.md.
- Fork the repository and create a branch from the latest main/default branch.
- Use a descriptive branch name such as
fix/Web0.0.5-2,feat/inventory-export, ordocs/installation-guide. - Install dependencies:
pnpm install
- Run the app locally:
pnpm dev:desktop
- Make your changes and verify them with the relevant checks.
- Keep changes focused and well-scoped.
- Include a clear summary of the problem and the solution.
- Add or update documentation when behavior changes.
- Reference any related issue numbers.
- Ensure the branch is up to date before requesting review.
- The change is understandable and documented.
- The implementation does not introduce obvious regressions.
- The PR title clearly describes the work.
- The change respects the project’s AGPL licensing model.
Open a discussion or issue if you need help getting started.