Contribution Guidelines

This document provides an overview of how to contribute to the Rummage project. For detailed guidelines on specific aspects of contribution, please refer to the following resources:

• Documentation Guide - Guidelines for contributing to documentation
• Git Workflow Guidelines - Recommended git workflow and commit message format
• Testing Guide - Guidelines for writing and running tests

We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

Getting Started

1. Fork the repository
2. Clone your fork locally
3. Set up the development environment
4. Create a new branch for your feature or bug fix
5. Make your changes following our coding standards
6. Write or update tests as needed
7. Commit your changes with clear, descriptive commit messages (see Git Workflow Guidelines)
8. Push your branch to your fork
9. Submit a pull request to the main repository

Pull Request Process

1. Ensure your code passes all tests and linting checks
2. Update documentation as necessary
3. Include a clear description of the changes in your pull request
4. Link any related issues using the appropriate GitHub syntax
5. Wait for a maintainer to review your pull request
6. Address any feedback provided by reviewers

Thank you for contributing to Rummage!