CONTRIBUTING
Contributing to TRANSLUX
Section titled “Contributing to TRANSLUX”We love your input! We want to make contributing to TRANSLUX as easy and transparent as possible, whether it’s:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We Develop with Github
Section titled “We Develop with Github”We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
All Code Changes Happen Through Pull Requests
Section titled “All Code Changes Happen Through Pull Requests”Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - Ensure you have read the
ARCHITECTURE.mdand understand the core FSM flow. - If you’ve added code that should be tested, add tests.
- Update the documentation.
- Ensure the test suite passes (
bun test). - Make sure your code is compliant with our
sync.bbscripts syncing blueprint against repo reality.
Any Contributions Must Adhere to Human-Made Principles
Section titled “Any Contributions Must Adhere to Human-Made Principles”We mandate that non-trivial logical components are primarily written and reasoned by human intelligence. LLMs may be used as stylistic assistants or refactors but must never dictate unchecked structural or core state-machine behavior.
Report bugs using GitHub Issues
Section titled “Report bugs using GitHub Issues”We use GitHub issues to track public bugs. Report a bug by opening a new issue; it’s that easy!
License
Section titled “License”By contributing, you agree that your contributions will be licensed under its AGPL-3.0 License.