Skip to content

docs: add Contributing section to README#89

Merged
jbampton merged 3 commits intomainfrom
copilot/create-readme-with-contributing-instructions
Apr 10, 2026
Merged

docs: add Contributing section to README#89
jbampton merged 3 commits intomainfrom
copilot/create-readme-with-contributing-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 9, 2026

The README lacked any contributor guidance — no setup steps, no workflow reference, no code-quality expectations.

Changes

  • Prerequisites table — Bun ≥ 1.3.11, uv, Python ≥ 3.13, Node.js ≥ 24, Git
  • Getting started — fork/clone, make install, make dev
  • Development workflow table — all make targets (dev, build, lint, prek, prek-manual, build-games, clean, help)
  • Code quality checks — explains all three prek tiers with exact commands:
    • Standard: make prek
    • Manual: make prek-manual
    • Audit: prek run -a -c .pre-commit-config-audit.yaml
  • Branch & PR guidelines — branch naming, push, PR target (main), CODEOWNERS review
  • Code style — ESLint/Biome for TS/JS, markdownlint (125 char limit), yamllint, editorconfig

Copilot AI linked an issue Apr 9, 2026 that may be closed by this pull request
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 9, 2026

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

Project Deployment Actions Updated (UTC)
metropolis-retro Ready Ready Preview, Comment Apr 9, 2026 7:10am

@deepsource-io
Copy link
Copy Markdown

deepsource-io bot commented Apr 9, 2026

DeepSource Code Review

We reviewed changes in 8c8df5e...acedab1 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade   Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
JavaScript Apr 9, 2026 7:10a.m. Review ↗
Secrets Apr 9, 2026 7:10a.m. Review ↗
Python Apr 9, 2026 7:10a.m. Review ↗

@jbampton jbampton added the documentation Improvements or additions to documentation label Apr 9, 2026
@github-project-automation github-project-automation bot moved this to Backlog in METROPOLIS Apr 9, 2026
@jbampton jbampton added this to the Retro milestone Apr 9, 2026
@jbampton jbampton moved this from Backlog to In progress in METROPOLIS Apr 9, 2026
Copilot AI changed the title [WIP] Add README with contributing instructions docs: add Contributing section to README Apr 9, 2026
Copilot AI requested a review from jbampton April 9, 2026 07:08
@jbampton jbampton marked this pull request as ready for review April 9, 2026 07:11
@jbampton jbampton requested a review from BaseMax as a code owner April 9, 2026 07:11
@jbampton jbampton moved this from In progress to In review in METROPOLIS Apr 9, 2026
@jbampton jbampton merged commit 39d07a6 into main Apr 10, 2026
12 of 13 checks passed
@jbampton jbampton deleted the copilot/create-readme-with-contributing-instructions branch April 10, 2026 00:05
@github-project-automation github-project-automation bot moved this from In review to Done in METROPOLIS Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Create README with contributing instructions

2 participants