Skip to content

docs: add CONTRIBUTING.md with development and PR workflow guide#389

Merged
tonyalaribe merged 2 commits into
monoscope-tech:masterfrom
okwn:contrib/monoscope/contributing-ci-hardening
May 23, 2026
Merged

docs: add CONTRIBUTING.md with development and PR workflow guide#389
tonyalaribe merged 2 commits into
monoscope-tech:masterfrom
okwn:contrib/monoscope/contributing-ci-hardening

Conversation

@okwn
Copy link
Copy Markdown
Contributor

@okwn okwn commented May 20, 2026

Summary

Adds a CONTRIBUTING.md guide covering:

  • Development setup — prerequisites (GHCup, Docker, Node.js 22, LLVM, libpq), initial clone and git hook setup
  • Running locally — , optional profiles (dev, test), environment variables
  • Building from source — , live-reload with ghcid --command 'cabal repl monoscope --ghc-options="-Wno-error=unused-imports -Wno-error=unused-top-binds" --with-compiler=ghc-9.12.2' --test ':run Start.startApp' --warnings
  • Running tests — unit tests (), doctests (), integration tests (), Makefile aliases
  • Code style — Fourmolu auto-commits on push (no manual formatting needed), HLint linting and auto-fix, Prettier for frontend
  • PR workflow — fork & branch conventions, making changes, auto-formatting behavior on push, opening a PR
  • Project structure overview

Files Changed

  • (new) — 253 lines

okwn added 2 commits May 20, 2026 20:40
Add Project Structure section describing app/, cli/, web-components/, and src/
directories with their respective purposes.
@tonyalaribe
Copy link
Copy Markdown
Contributor

Thanks for the PR @okwn

@tonyalaribe tonyalaribe merged commit 8ab5cbc into monoscope-tech:master May 23, 2026
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.

2 participants