Repository navigation
docs: add CONTRIBUTING.md - #98
Merged
shirshanka merged 2 commits intoSep 15, 2026
Merged
shirshanka merged 2 commits into
shirshanka merged 2 commits into
Conversation
Replace the generic "see README.md / equivalent steps" placeholders with the actual Makefile commands (make install, make dev, make test), add the required make lint (ruff + format + mypy, mirrors CI) and make fix, and align prerequisites with the mise-based Node/pnpm setup. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wn2yUdhpmxqew5Jb4NrMcR
shirshanka
approved these changes
Sep 15, 2026
shirshanka
left a comment
Contributor
There was a problem hiding this comment.
Thanks @Naveenkumar2028 — great to finally have a CONTRIBUTING.md, and the structure (prereqs → setup → tests → Conventional Commits → PR flow) is exactly right. 🙏
I pushed one follow-up commit (maintainer edit) to swap the generic "see README.md / equivalent steps" placeholders for the repo's actual commands, since they're all one-liners:
make install/make devfor setup, aligned the prereqs with themise-based Node + pnpm setup (.mise.toml).- Added the required
make lint(ruff + format + mypy — it mirrors CI and is the check that most often needs to pass before a PR is green), plusmake fixandmake test.
Verified every referenced target exists in the Makefile. Approving — thanks for closing this one out! 🎉
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a contributor guide covering prerequisites, development setup, testing, Conventional Commits, and the pull-request workflow.
Closes #39