Contribution Guidelines

Thank you for considering contributing to the rheadb project! By participating, you help improve the project for everyone. Whether you're reporting a bug, suggesting a new feature, or submitting code changes, your contributions are valued.

Reporting Bugs

If you encounter a bug or unexpected behavior in rheadb, please follow these steps to report it:

1. Search for Existing Issues: Before creating a new issue, search the GitHub issue tracker to see if the bug has already been reported.

2. Create a New Issue: If no existing issue matches the problem you encountered, open a new issue on the GitHub repository. Provide a clear and detailed description of the issue, including steps to reproduce it, expected behavior, and any relevant error messages or screenshots.

3. Labeling: Use appropriate labels when creating the issue, such as [BUG] or [HELP WANTED] to help categorize and prioritize it.

Requesting Features

If you have an idea for a new feature or enhancement, please follow these steps to request it:

1. Search for Existing Requests: Before submitting a new feature request, search the GitHub issue tracker to see if the feature has already been requested.

2. Create a New Issue: If the feature hasn't been requested yet, open a new issue on the GitHub repository. Provide a clear description of the feature you'd like to see added, along with any relevant use cases or examples.

3. Labeling: Use the [Feature Request] label when creating the issue to indicate that it's a feature request.

Contributing Code

If you'd like to contribute code changes to rheadb, please follow these steps:

1. Fork the Repository: Fork the rheadb repository on GitHub and clone your fork to your local machine.

2. Create a New Branch: Create a new branch for your feature or bug fix. Use a descriptive name that reflects the purpose of your changes.

3. Make Changes: Make your changes to the codebase, following the project's coding standards and conventions. Ensure that your changes are well-documented and include appropriate tests.

4. Test Changes: Before submitting a pull request, ensure that all existing tests pass and that your changes don't introduce any new issues.

5. Submit a Pull Request: Once your changes are ready, submit a pull request to the rheadb repository. Provide a clear and detailed description of your changes and their purpose. Be sure to reference any related issues or feature requests in the pull request description.

6. Code Review: Your pull request will be reviewed by project maintainers. Be responsive to any feedback or requests for changes and make updates as necessary.

7. Merge: Once your pull request has been approved and all feedback addressed, it will be merged into the main branch.

Development

Install dependencies:

pip install -e ".[test]"

Run tests with coverage:

pytest --cov

Code of Conduct

Please note that all contributions to rheadb are subject to the project's Code of Conduct. By participating in this project, you agree to abide by its terms and guidelines.

Thank you for contributing to rheadb!