# Contributing to dolibarr-api-mcp We appreciate your interest in contributing to this project! This document provides guidelines for contributing. ## Table of Contents - [Code of Conduct](#code-of-conduct) - [Getting Started](#getting-started) - [How to Contribute](#how-to-contribute) - [Development Workflow](#development-workflow) - [Commit Messages](#commit-messages) - [Pull Request Process](#pull-request-process) ## Code of Conduct This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to hello@mokoconsulting.tech. ## Getting Started 1. Fork the repository 2. Clone your fork locally 3. Install dependencies: `npm install` 4. Build: `npm run build` 5. Create a new branch for your work ## How to Contribute ### Reporting Bugs - Use the Gitea issue tracker - Describe the bug clearly with steps to reproduce - Include the Dolibarr version you're connecting to - Include relevant logs or error messages ### Adding New Tools If you want to add support for a Dolibarr API endpoint not yet covered: 1. Check the [Dolibarr API Explorer](https://your-dolibarr.com/api/index.php/explorer) for endpoint details 2. Add the tool registration in `src/index.ts` following the existing patterns 3. Update `docs/API.md` with the new tool's parameter table 4. Update `README.md` tool listing 5. Update `CHANGELOG.md` ### Contributing Code - Pick an issue or create one - Fork the repository and create a branch - Make your changes following the project conventions - Submit a pull request ## Development Workflow 1. Ensure your fork is up to date with the main repository 2. Create a feature branch from `main` 3. Make your changes 4. Test against a Dolibarr instance (use `npm run setup` to configure a dev connection) 5. Build with `npm run build` to catch TypeScript errors 6. Commit your changes with clear messages 7. Push to your fork 8. Create a pull request ## Commit Messages Follow the conventional commit format: ``` ():