Skip to content

docs: add CONTRIBUTING.md - #18

Merged
CodeForContribute merged 1 commit into
developfrom
add-contributing-md
May 4, 2026
Merged

CodeForContribute merged 1 commit into
developfrom
add-contributing-md

Conversation

@CodeForContribute

Copy link
Copy Markdown
Owner

Summary

Adds a CONTRIBUTING.md to help new contributors get started.

Covers:

  • Local setup (Node, Postgres, Redis, env, migrations, dev server, worker)
  • Branching model (develop as integration branch) and Conventional Commits
  • PR process and CI expectations (lint, unit, e2e, Gitleaks)
  • Testing guidance (keep coverage 80%+, no mocked DBs in integration tests)
  • Coding style notes (TS-only, types over any, comments explain why)
  • Templates for bug reports and feature requests

Why

The LinkedIn post calling for contributors will land softer with a clear on-ramp. Right now there's no CONTRIBUTING.md, so new contributors have to reverse-engineer setup from package.json, docker-compose.yml, and .env.example.

Test plan

  • Render check on the GitHub PR view (no broken markdown)
  • Links to issues / discussions / labels resolve correctly
  • Commands in the Setup section match package.json scripts

Documents local setup, development workflow, branching/commit
conventions, PR process, testing expectations, and how to report
bugs or suggest features. Aims to make it easy for new contributors
to get started.
@vercel

vercel Bot commented May 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
flowforge Building Building Preview, Comment May 4, 2026 9:13am

@CodeForContribute
CodeForContribute merged commit 56945ce into develop May 4, 2026
3 of 5 checks passed
@CodeForContribute
CodeForContribute deleted the add-contributing-md branch May 4, 2026 09:13

This branch had an error being deployed

1 failed deployment
Preview — 0d343cdc Deployed May 4, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant