# Contributing to {{REPO_NAME}}

Thank you for your interest in contributing to {{REPO_NAME}}! This document provides guidelines and instructions for contributing to this project.

## Code of Conduct

By participating in this project, you agree to abide by the [LlamaSearch Code of Conduct](CODE_OF_CONDUCT.md).

## How Can I Contribute?

### Reporting Bugs

Before submitting a bug report:

1. Check the [issue tracker](https://github.com/llamasearch/{{REPO_SLUG}}/issues) to see if the problem has already been reported.
2. If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/llamasearch/{{REPO_SLUG}}/issues/new).

When reporting bugs, include:

- A clear, descriptive title
- Steps to reproduce the issue
- Expected behavior and what actually happened
- Screenshots or code snippets if applicable
- Environment details (OS, browser, version, etc.)

### Suggesting Enhancements

Enhancement suggestions are tracked as [GitHub issues](https://github.com/llamasearch/{{REPO_SLUG}}/issues).

When suggesting enhancements:

1. Use a clear, descriptive title
2. Provide a detailed description of the suggested enhancement
3. Explain why this enhancement would be useful
4. Include any relevant examples or mockups

### Pull Requests

1. Fork the repository
2. Clone your fork: `git clone https://github.com/your-username/{{REPO_SLUG}}.git`
3. Create a new branch: `git checkout -b feature/your-feature-name`
4. Make your changes
5. Run the tests: `{{TEST_COMMAND}}`
6. Commit your changes: `git commit -m "Add some feature"`
7. Push to the branch: `git push origin feature/your-feature-name`
8. Submit a pull request

## Development Setup

### Prerequisites

- {{PREREQUISITE_1}}
- {{PREREQUISITE_2}}
- {{PREREQUISITE_3}}

### Installation

```bash
{{DEVELOPMENT_SETUP_INSTRUCTIONS}}
```

### Development Workflow

1. Create a new branch for your feature or bugfix
2. Make your changes
3. Write or update tests
4. Run the test suite to ensure everything passes
5. Update documentation if necessary
6. Submit a pull request

## Coding Guidelines

### Code Style

{{REPO_NAME}} follows {{STYLE_GUIDE_NAME}} for code style. We use the following tools to enforce consistent style:

{{STYLE_ENFORCEMENT_TOOLS}}

### Testing

All new features should include appropriate tests:

```bash
{{TEST_INSTRUCTIONS}}
```

### Documentation

- Update the README.md if necessary
- Add or update documentation in the `docs/` directory
- Document all public APIs
- Update the CHANGELOG.md file

## Git Commit Messages

- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests after the first line

## Release Process

{{RELEASE_PROCESS}}

## License

By contributing to {{REPO_NAME}}, you agree that your contributions will be licensed under the same [MIT License](LICENSE) that covers the project. 