Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.37 KB

Contributing to Recrify

Thank you for your interest in contributing to Recrify.

We welcome improvements that make the project more stable, useful, and maintainable. Please keep contributions focused, well-scoped, and aligned with the existing product direction.

Getting Started

  1. Create an issue and discuss about your contributions.
  2. Fork the repository.
  3. Clone your fork locally.
  4. Create a new branch for your change.
  5. Make and test your changes.
  6. Commit with a clear message.
  7. Open a pull request with a concise explanation of what changed and why.

Contribution Guidelines

  • Keep pull requests focused on one logical change.
  • Follow the existing code structure and naming conventions.
  • Avoid unrelated refactors in the same pull request.
  • Test your changes before submitting.
  • Update documentation when behavior, setup, or workflows change.

Pull Request Expectations

When opening a pull request, include:

  • A short summary of the change
  • Why the change was needed
  • Any setup or testing notes
  • Screenshots for UI changes when relevant

Issues and Feature Requests

Before opening a large feature request or major change, it is helpful to first open an issue so the direction can be discussed before implementation.

Communication

Please keep all discussions respectful and constructive. By contributing, you agree to follow the project's Code of Conduct.