Speck-It

Contributing

Learn how to contribute to the Speck-It MCP Server project.

Getting Started

How to set up your development environment and start contributing.

Fork the Repository

Fork the repository on GitHub and clone your fork locally.

git clone https://github.com/wuxnz/speck-it-mcp-server.git

Create a Feature Branch

Create a new branch for your contribution.

git checkout -b feature/your-feature-name

Install Dependencies

Install the required dependencies for development.

uv add --requirements requirements.txt

Start Development

Run the development server to test your changes.

uv dev

Development Workflow

Best practices for contributing to the project.

Code Style

Follow the existing coding patterns and conventions.

  • Thouroughly explain what your PR does
  • Write descriptive commit messages
  • Include proper documentation

Testing

Ensure your changes are properly tested.

  • Ensure that your feature works as intended
  • Test your changes with at least 3 different models
  • (If Possible) Test your changes on two different agents

Documentation

Keep documentation up to date with your changes.

  • Update API documentation for new tools
  • Add examples for new features
  • Update the README if needed
  • Document any breaking changes

Submitting Changes

How to submit your contributions for review.

Commit Your Changes

Commit your changes with a clear message.

git commit -m "feat: add new feature description"

Push to Your Fork

Push your changes to your forked repository.

git push origin feature/your-feature-name

Create a Pull Request

Create a pull request on the original repository.

  • Provide a clear title and description
  • Link any relevant issues
  • Include screenshots if applicable
  • Request review from maintainers

Code Review Process

What happens after you submit a pull request.

1

Automated checks run (linting, formatting, tests)

2

Maintainers will review your code for quality and correctness

3

Feedback is provided for any required changes

4

Once approved, your PR is merged into the main branch

Community Guidelines

How we work together as a community.

1

Be respectful and inclusive in all interactions

2

Provide constructive feedback and suggestions

3

Help others who are learning or struggling

4

Follow the code of conduct

5

Focus on what is best for the community

Getting Help

Discussions

Join our GitHub Discussions to ask questions and share ideas.

View Discussions

Issues

Report bugs or request features through GitHub Issues.

Report Issue

License

This project is licensed under the BSD 3-Clause License. By contributing, you agree that your contributions will be licensed under the same license.

View License