Thank you for considering contributing to the CEX System! This document provides guidelines and instructions for contributing to the project.
- Code of Conduct
- Getting Started
- Development Environment
- Project Structure
- Testing
- Pull Request Process
- Coding Standards
- Documentation
By participating in this project, you are expected to uphold our Code of Conduct:
- Use welcoming and inclusive language
- Be respectful of differing viewpoints and experiences
- Gracefully accept constructive criticism
- Focus on what is best for the community
- Show empathy towards other community members
- Fork the repository
- Clone your fork:
git clone https://github.com/your-username/CEX.git - Create a branch for your changes:
git checkout -b feature/your-feature-name
- Navigate to the local app directory:
cd local/app - Install dependencies:
pip install -r requirements.txt - Run the app:
python app.py
- Navigate to the backend directory:
cd backend - Install dependencies:
npm install - Run the server:
npm run dev
- Navigate to the web directory:
cd web - Install dependencies:
npm install - Run the development server:
npm run dev
local/- Local application (Python + React)app/- Flask backendfrontend/- React frontend
backend/- Fastify API serverweb/- Next.js public websitedocs/- Documentation
We use automated testing to ensure code quality and prevent regressions.
Run the tests for the local app:
cd local/app
python -m unittest discover testRun the tests for the backend:
cd backend
npm testAll new code should include appropriate tests. Please ensure your tests cover both the happy path and edge cases.
- Update the README.md or documentation with details of changes if appropriate
- Add or update tests for your changes
- Ensure all tests pass before submitting your pull request
- Update the version numbers in any examples files and the README.md to the new version that this Pull Request would represent
- The pull request will be merged once it receives approval from maintainers
- Follow PEP 8 style guide
- Use docstrings for functions and classes
- Use type hints where appropriate
- Follow ESLint configuration
- Use async/await for asynchronous code
- Use descriptive variable and function names
- Keep documentation up to date with code changes
- Document all public APIs
- Use clear, concise language
- Include examples where appropriate
Thank you for contributing to the CEX System!