MokoConsulting/mcp-mokocrm-api
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity
Files
version
mcp-mokocrm-api/CONTRIBUTING.md
T
Jonathan Miller 73c7d5554f
Changelog Validation / Validate CHANGELOG.md (push) Failing after 3s
Details
Standards Compliance / Secret Scanning (push) Successful in 3s
Details
Standards Compliance / License Header Validation (push) Failing after 3s
Details
Standards Compliance / Repository Structure Validation (push) Failing after 3s
Details
Standards Compliance / Coding Standards Check (push) Failing after 3s
Details
Standards Compliance / Workflow Configuration Check (push) Failing after 2s
Details
Standards Compliance / Documentation Quality Check (push) Successful in 2s
Details
Standards Compliance / README Completeness Check (push) Failing after 3s
Details
Standards Compliance / Git Repository Hygiene (push) Successful in 3s
Details
Standards Compliance / Script Integrity Validation (push) Successful in 6s
Details
Standards Compliance / Line Length Check (push) Failing after 4s
Details
Standards Compliance / File Naming Standards (push) Successful in 3s
Details
Standards Compliance / Insecure Code Pattern Detection (push) Successful in 2s
Details
Standards Compliance / Version Consistency Check (push) Successful in 35s
Details
CodeQL Security Scanning / Analyze (actions) (push) Failing after 1m12s
Details
Standards Compliance / Dead Code Detection (push) Successful in 4s
Details
Standards Compliance / File Size Limits (push) Successful in 3s
Details
Standards Compliance / Binary File Detection (push) Successful in 2s
Details
Standards Compliance / TODO/FIXME Tracking (push) Successful in 2s
Details
Standards Compliance / Code Complexity Analysis (push) Successful in 32s
Details
Standards Compliance / Code Duplication Detection (push) Successful in 33s
Details
Standards Compliance / Broken Link Detection (push) Successful in 2s
Details
Standards Compliance / API Documentation Coverage (push) Successful in 2s
Details
Standards Compliance / Accessibility Check (push) Successful in 3s
Details
Standards Compliance / Performance Metrics (push) Successful in 2s
Details
CodeQL Security Scanning / Analyze (javascript) (push) Failing after 1m36s
Details
Standards Compliance / Dependency Vulnerability Scanning (push) Successful in 37s
Details
Standards Compliance / Unused Dependencies Check (push) Successful in 37s
Details
Standards Compliance / Terraform Configuration Validation (push) Successful in 5s
Details
CodeQL Security Scanning / Security Scan Summary (push) Successful in 1s
Details
Standards Compliance / Enterprise Readiness Check (push) Successful in 33s
Details
Standards Compliance / Repository Health Check (push) Successful in 33s
Details
Standards Compliance / Compliance Summary (push) Failing after 1s
Details
Sync Version from README / Propagate README version (push) Failing after 38s
Details
docs: add CHANGELOG, CONTRIBUTING, SECURITY, and sqlfilter builder 
Add all required MokoStandards documentation files. Refactor inline
sqlfilters strings to use buildSqlFilter() and searchFilter() helpers
for safe query construction with proper escaping.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-05-07 14:15:27 -05:00

4.9 KiB
Raw Permalink Blame History

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

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 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:

<type>(<scope>): <subject>

<body>

<footer>

Types: feat, fix, docs, style, refactor, test, chore, ci, build, perf, revert

Example:

feat(tools): add shipment management tools

Add dolibarr_shipments_list, dolibarr_shipment_get, and
dolibarr_shipment_validate tools for the /shipments API endpoint.

Pull Request Process

  1. Update documentation for any new tools
  2. Follow the project's coding style and conventions
  3. Ensure npm run build succeeds without errors
  4. Update the CHANGELOG.md with your changes
  5. Request review from maintainers
  6. Address any feedback promptly
  7. Once approved, your PR will be merged

Style Guidelines

  • Use tabs for indentation
  • All source files must include the Moko Consulting copyright header
  • Use snake_case for local variables (matching Dolibarr API field names)
  • Use Zod for all tool parameter validation
  • Follow the formatResponse() pattern for consistent error handling

Infrastructure Standards

All repositories in the MokoConsulting org follow these conventions:

Release Tags

Every repo maintains 5 standard release channel tags:

  • development - Active development builds
  • alpha - Early internal testing
  • beta - Broader testing / client UAT
  • release-candidate - Final QA before production
  • stable - Production release

Branch Protection

  • main is protected; only jmiller can push directly
  • All other contributors must use pull requests
  • PRs are automatically reviewed by Claude Code

CI/CD

  • Gitea Actions runs all CI workflows
  • Workflows live in .gitea/workflows/

Secrets

All repos have GA_TOKEN and GH_TOKEN as Actions secrets for API access.

Questions?

If you have questions about contributing, feel free to open an issue or contact the maintainers at hello@mokoconsulting.tech.

Revision History

Date Version Author Notes
2026-05-07 0.0.1 jmiller Initial contributing guidelines
Reference in New Issue View Git Blame Copy Permalink