Contributing

​

Overview

​

Getting Started

1. Fork the repository
2. Clone your fork
3. Create a feature branch
4. Make your changes
5. Add tests
6. Submit a pull request

​

Development Setup

​

Backend

cd conformly-backend
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

​

Frontend

cd conformly-frontend
npm install
npm run dev

​

Code Style

​

Backend

• Use black for formatting
• Use isort for import sorting
• Follow PEP 8 guidelines
• Add type hints

black app/
isort app/
flake8 app/

​

Frontend

• Use ESLint for linting
• Follow TypeScript best practices
• Use Prettier for formatting

npm run lint
npm run format

​

Testing

• Write tests for new features
• Ensure all tests pass
• Maintain or improve test coverage

​

Pull Request Process

1. Update documentation if needed
2. Add tests for new features
3. Ensure all tests pass
4. Update CHANGELOG.md
5. Submit PR with clear description

​

Code of Conduct

• Be respectful and inclusive
• Welcome newcomers
• Focus on constructive feedback