Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (37 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

50 lines (37 loc) · 1.86 KB

Contributing to Memov

Thank you for your interest in contributing to Memov! We welcome all kinds of contributions, including bug reports, feature requests, code improvements, and documentation.

How to Contribute

1. Reporting Issues

  • Search existing issues before opening a new one.
  • Provide a clear, descriptive title and as much relevant information as possible (steps to reproduce, logs, screenshots, etc).

2. Requesting Features

  • Open a new issue and label it as a feature request.
  • Describe your use case and why the feature would be helpful.

3. Submitting Pull Requests

  • Fork the repository and create your branch from main.
  • Write clear, concise commit messages.
  • If your change is user-facing, update the documentation as needed.
  • Ensure your code passes all tests and lints (see below).
  • Open a pull request and describe your changes and motivation.

4. Code Style

  • Use clear, descriptive variable and function names.

  • Add comments and docstrings where appropriate.

  • Keep code modular and avoid large, monolithic functions.

  • Before submitting a pull request, run:

    poetry run pre-commit run --all-files

    This will check and automatically fix code formatting and linting issues.

5. Tests

  • Add or update tests for any new features or bug fixes.
  • Run all tests before submitting your PR.
  • If you are unsure how to test your change, ask for guidance in your PR.

6. Documentation

  • Update the README or relevant docs if your change affects usage or behavior.
  • Keep documentation clear and concise.

Code of Conduct

Be respectful and constructive. We are committed to providing a welcoming and inclusive environment for everyone.

Questions?

If you have any questions, open an issue or start a discussion. We’re happy to help!

Thank you for helping make Memov better!