Loading...
Loading...
Loading...
Thank you for your interest in contributing to ControlWeave! This document
# Contributor License Agreement (CLA)
## Contributing to ControlWeave
Thank you for your interest in contributing to ControlWeave! This document
covers both the Contributor License Agreement and how to get started.
## Getting Started
1. **Fork the repository**
2. **Create a feature branch** following our naming convention:
```
feat/CW-<issue-number>/<short-description>
```
Examples:
```bash
feat/CW-42/add-gdpr-framework
fix/CW-15/pagination-offset-bug
docs/CW-7/improve-setup-guide
```
3. **Make your changes** following the guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md)
4. **Open a Pull Request** — the CLA bot will ask you to sign on your first PR
For full development setup and coding standards, see [CONTRIBUTING.md](./CONTRIBUTING.md).
## Contributor License Agreement
### ControlWeave Community Edition
This Contributor License Agreement ("CLA") applies to any contribution you make
to ControlWeave Community Edition ("the Project"), maintained by
sherifconteh-collab.
### 1. Definitions
- **"Contribution"** means any code, documentation, or other material submitted
to the Project via pull request, issue, or other mechanism.
- **"You"** (or **"Contributor"**) means the individual or legal entity making
the Contribution.
### 2. Grant of License
By submitting a Contribution, you grant to the Project maintainers a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable license to use,
reproduce, modify, prepare derivative works of, publicly display, publicly
perform, sublicense, and distribute your Contribution and any derivative works
under the terms of the [AGPL-3.0 License](./LICENSE).
### 3. Representations
You represent that:
- You are legally entitled to grant the above license.
- Each Contribution is your original creation or you have the right to submit it.
- Your Contribution does not violate any third-party intellectual property rights.
- If your employer has rights to intellectual property that you create, you have
received permission to make the Contribution on behalf of that employer, or
your employer has waived such rights for the Contribution.
### 4. No Obligation
You understand that the decision to include your Contribution in the Project is
entirely at the discretion of the Project maintainers. You are not expected to
provide support for your Contribution unless you choose to do so.
### 5. How to Sign
To sign this CLA, comment on the relevant pull request with:
```
I have read the CLA Document and I hereby sign the CLA
```
Your signature will be recorded automatically.
## Contact
For questions about this CLA or contributing, email **[email protected]**.
For development, you'll want to run vimflowy locally.
[Back to README](../README.md)
This document describes setting up a development environment for working on
This document describes how to setup your environment with Python and uv,