First off, thank you for taking the time to contribute! It is people like you who make Celerix a better tool for everyone.
As a privacy-first, high-performance project, we have a few specific guidelines to ensure the application remains lean, fast, and secure.
Before contributing, please remember:
- No Telemetry: We do not accept features that require tracking, analytics, or external data collection.
- Local First: Features should work offline whenever possible.
- Data Sovereignty: User data must stay on the user's machine.
To maintain our "Performance Engineering" pillar, we follow these rules:
- Fluid Workflows: Ensure that the workflow tracking engine remains responsive and intuitive.
- Auditability: Write clean, documented code. Since we are privacy-focused, users must be able to easily audit what the code is doing with their data.
- Use the GitHub Issues tab.
- Describe the bug clearly and provide steps to reproduce it.
- Include your OS (Windows/macOS/Linux) and the version of Celerix you are using.
- Fork the repo and create your branch from
main. - Lint your code: Ensure your code follows the project's style.
- Description: Explain what your PR does and why it's a good fit for Celerix Flow.
By contributing to Celerix Flow, you agree that your contributions will be licensed under the MIT License.
Thank you for helping us build software that respects users!