Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (88 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

124 lines (88 loc) · 3.35 KB
Raw

Contributing to MarketX Backend Engine

First off, thank you for considering contributing to MarketX! It's people like you that make MarketX such a great tool.

This guide will help you get started with your first contribution. Please read it thoroughly to understand our development workflow and standards.

🚀 Getting Started

1. Prerequisites

Ensure you have the following installed:

  • Node.js (v18+)
  • npm (v9+)
  • Docker & Docker Compose

2. Diagnostics

Before you start debugging setup issues, run our diagnostics tool to ensure your environment is correctly configured:

npm run doctor

Or if you prefer using make:

make doctor

This tool checks for required versions, .env configuration, and connectivity to services (Postgres, Redis, RabbitMQ).

3. Fork and Clone

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/MarketX-backend.git
cd MarketX-backend
  3. Add the upstream repository as a remote: 
    git remote add upstream https://github.com/Cybermaxi7/MarketX-backend.git

4. Environment Setup

  1. Install dependencies: 
    npm install
  2. Set up your environment variables: 
    cp .env.example .env
    Edit .env and fill in the necessary credentials.

5. Local Infrastructure

We use Docker Compose to spin up the required services (PostgreSQL, Redis, RabbitMQ).

docker compose --profile local-dev up -d

For more details, see docs/local-infra.md.

🛠️ Development Workflow

Branching Strategy

  • Always create a new branch for your work:
    • feature/your-feature-name for new features.
    • bugfix/your-fix-name for bug fixes.
    • refactor/your-refactor-name for code improvements.
    • docs/your-doc-update for documentation changes.

Coding Standards

We use ESLint and Prettier to maintain code quality and consistency.

  • Linting: npm run lint (validation only)
  • Auto-fixing lint issues: npm run lint:fix
  • Formatting: npm run format
  • Typechecking: npm run typecheck

Helpful Scripts

  • Makefile: We provide a Makefile with common commands. Run make help to see all available targets.
  • Git Hooks: You can set up a pre-commit hook that runs linting and typechecking by running: 
    ./scripts/setup_hooks.sh

Please ensure your code passes linting and typechecking before submitting a PR.

Commit Messages

We follow the Conventional Commits specification.

🧪 Testing

We value high test coverage. Ensure you add tests for any new features or bug fixes.

  • Run all tests: npm run test
  • Run pre-PR confidence suite: npm run pr:check
  • Check coverage: npm run test:cov

📖 Documentation

  • API Docs: Update Swagger metadata and run npm run docs:generate.
  • ADRs: Add or update an ADR in docs/adr/ for significant architectural changes.

📤 Submission Process

  1. Rebase: Ensure your branch is up to date with upstream/develop.
  2. Confidence Check: Run npm run pr:check and npm run doctor.
  3. Push: Push your branch to your fork.
  4. Open PR: Open a Pull Request against the develop branch of the upstream repository.

Thank you for your contribution! 🚀