Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 1.56 KB

Contributing to ReAG

Thank you for your interest in contributing to ReAG! Your contributions help make this project better for everyone. Please take a moment to review these guidelines to ensure a smooth and collaborative experience.

How to Contribute

Reporting Issues

  • Use GitHub Issues to report bugs or request new features.
  • Search existing issues to avoid duplicates before filing a new one.
  • Provide clear and concise details:
    • Steps to reproduce the issue
    • Expected behavior versus the observed behavior
    • Information about your environment (OS, version, etc.)

Submitting Pull Requests

  • Fork the repository and create a feature branch off of the main branch.
  • Clearly describe your changes and link any related issues in your pull request.
  • Ensure your code follows the project’s coding standards and style guidelines.
  • Include tests if applicable to verify your changes.
  • Keep pull requests focused on a single purpose or issue.

Code Style Guidelines

  • Follow the project’s existing code style and best practices.
  • Write clear, self-explanatory commit messages.
  • Document your code where necessary and update related documentation if needed.

Communication

  • Engage with maintainers and fellow contributors via GitHub Discussions or chat channels.
  • For larger changes, please open an issue first for discussion before submitting a pull request.

Licensing

  • By contributing, you agree that your contributions will be licensed under the project's license.

Thank you again for helping to improve ReAG. We look forward to your contributions!