# Contributing

**Package:** CommonMark Routes | **Version:** 1 | **URL:** https://mozex.dev/docs/commonmark-routes/v1/contributing

---

We welcome contributions of all kinds: bug fixes, new features, documentation improvements, and test coverage. Here's how to get involved.

## Getting Started

1. **Fork the repository** on [GitHub](https://github.com/mozex/commonmark-routes)
2. **Clone your fork** locally:
   ```bash
   git clone git@github.com:your-username/commonmark-routes.git
   cd commonmark-routes
   ```
3. **Install dependencies**:
   ```bash
   composer install
   ```

## Making Changes

Create a branch for your work:

```bash
git checkout -b your-feature-name
```

Keep each pull request focused on a single change. If you're fixing a bug and improving something else, send two separate PRs. This makes review faster and keeps the git history clean.

## Code Quality

Before submitting, run the test suite:

```bash
composer test
```

This runs all checks including code style, static analysis, and tests. The CI pipeline runs the same command on every pull request, so catching issues locally saves time.

## Submitting a Pull Request

1. Push your branch to your fork
2. Open a pull request against the `main` branch
3. Fill in the PR template with a clear description of what changed and why
4. Link any related issues

We follow [Semantic Versioning](https://semver.org). If your change is a breaking change, mention it clearly in the PR description.

## Commit Guidelines

Write meaningful commit messages. Each commit should represent a single logical change. If you need to clean up your history, [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) before submitting.

## Have an Idea?

If you'd like to discuss a feature before writing code, start a conversation in [GitHub Discussions](https://github.com/mozex/commonmark-routes/discussions). That's the best place to propose ideas, get feedback, and coordinate with maintainers before opening a PR.

## Security

If you discover a security vulnerability, do not open a public issue. Email [hello@mozex.dev](mailto:hello@mozex.dev) directly.

---

## Table of Contents

- [Quick Start](https://mozex.dev/docs/commonmark-routes/v1)
- [AI Integration](https://mozex.dev/docs/commonmark-routes/v1/ai-integration)
- [Support Us](https://mozex.dev/docs/commonmark-routes/v1/support-us)
- [Requirements](https://mozex.dev/docs/commonmark-routes/v1/requirements)
- [Changelog](https://mozex.dev/docs/commonmark-routes/v1/changelog)
- [Contributing](https://mozex.dev/docs/commonmark-routes/v1/contributing)
- [Questions & Issues](https://mozex.dev/docs/commonmark-routes/v1/questions-and-issues)
- [About Mozex](https://mozex.dev/docs/commonmark-routes/v1/about)