Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (42 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 2.14 KB

Contributing to ReviewScope

We love your input! We want to make contributing to ReviewScope as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with GitHub

We use GitHub to host code, to track issues and feature requests, and to accept pull requests.

⚠️ Important Contribution Rule

Please do not start work or open a Pull Request unless an issue or task has been explicitly assigned to you.

This helps avoid duplicate work and keeps the project aligned with current priorities.

If you want to work on something:

  • Open an issue first or
  • Ask for an existing issue to be assigned to you

Development Workflow

  1. Fork the repo and create your branch from main.
  2. Install dependencies: 
    npm install
  3. Set up environment variables:
    • Copy .env.example to .env in the root and relevant app directories (apps/api, apps/worker, apps/dashboard).
    • Fill in the required keys (see README.md for details).
  4. Run the development environment: 
    npm run dev
    This will start all services (API, Worker, Dashboard) concurrently.

Coding Style

  • TypeScript: We use TypeScript for type safety. Please ensure all new code is typed.
  • Formatting: We use Prettier for code formatting. Run npm run format before committing.
  • Linting: We use ESLint. Run npm run lint to check for issues.
  • Commit Messages: Write clear, descriptive commit messages.

Project Structure

  • apps/: Contains the deployable applications (API, Dashboard, Worker).
  • packages/: Contains shared libraries and internal packages (Context Engine, LLM Core, Rules Engine, Security).

Report bugs using Github's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

License

By contributing, you agree that your contributions will be licensed under its MIT License.