Contributing
We welcome contributions to Cardealer DP! This guide will help you get started.
Prerequisites
Section titled “Prerequisites”- Node 24+ (with pnpm) - How to Install
- Python 3.12+ (with uv) - How to Install
Getting Started
Section titled “Getting Started”- Fork the repository on GitHub: https://github.com/datisthq/cardealerdp
- Clone your fork locally:
Terminal window git clone https://github.com/YOUR_USERNAME/cardealerdp.gitcd cardealerdp - Install dependencies using pnpm:
Terminal window pnpm install
Development Workflow
Section titled “Development Workflow”Available Scripts
Section titled “Available Scripts”pnpm configure
- Configure extension metadata (slug, title, description, etc.)pnpm generate
- Generate TypeScript and Python SDKs from schemaspnpm start
- Start the documentation site in development modepnpm build
- Build all packages (extension, SDKs)pnpm test
- Run linting and type checkingpnpm format
- Format code with Biomepnpm lint
- Check code quality with Biome
Making Changes
Section titled “Making Changes”-
Create a new branch for your feature or fix:
Terminal window git checkout -b feature/your-feature-name -
Make your changes to the extension, schemas, or documentation
-
Generate SDKs if you modified schemas:
Terminal window pnpm generate -
Test your changes:
Terminal window pnpm test -
Commit your changes with a descriptive message:
Terminal window git add .git commit -m "Your feature description" -
Push to your fork:
Terminal window git push origin feature/your-feature-name -
Open a Pull Request on GitHub from your fork to the main repository
Questions?
Section titled “Questions?”Feel free to open an issue on GitHub if you have any questions or need help!