Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 2.48 KB

Contributing to TomTom MCP Server

Thank you for your interest in contributing to the TomTom MCP Server! We welcome contributions from the community to help improve and grow this project.

Code of Conduct

Please note that this project adheres to the TomTom Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

How to Contribute

Reporting Issues

If you find a bug or have a suggestion for improving the project:

  1. Check if the issue already exists in the Issues section.
  2. If not, create a new issue with a clear description, including:
    • Steps to reproduce the problem
    • Expected behavior
    • Actual behavior
    • Environment details (OS, Node.js version, etc.)

Contributing Code

  1. Fork the repository
  2. Create a new branch for your feature or bugfix
  3. Make your changes, including appropriate test cases
  4. Ensure all tests pass by running npm test
  5. Make sure your code follows the project's coding standards
  6. Sign-off your commits according to the Developer Certificate of Origin (DCO)
  7. Submit a pull request with a clear description of the changes

Pull Request Process

  1. Update the README.md or documentation with details of changes if appropriate
  2. The PR will be reviewed by at least two TomTom maintainers
  3. You may be asked to make additional changes before your PR is accepted
  4. Once approved, a maintainer will merge your PR

Developer Certificate of Origin (DCO)

All contributions must be signed-off according to the Developer Certificate of Origin (DCO). This attests that you have the right to contribute the code you are submitting.

To sign-off your commits, add the --signoff option to your git commit command:

git commit --signoff -m "Your detailed commit message"

Or use the shorthand:

git commit -s -m "Your detailed commit message"

Coding Standards

  • Follow TypeScript best practices
  • Maintain 100% test coverage for new code
  • Document public APIs using JSDoc comments
  • Follow existing code style and formatting

License

By contributing to this project, you agree that your contributions will be licensed under the project's Apache License 2.0.

Thank you for contributing to the TomTom MCP Server!