Skip to content

docs: add CONTRIBUTING.md - #98

Merged
shirshanka merged 2 commits into
datahub-project:mainfrom
Naveenkumar2028:docs/add-contributing-guide
Sep 15, 2026
Merged

shirshanka merged 2 commits into
datahub-project:mainfrom
Naveenkumar2028:docs/add-contributing-guide

Conversation

@Naveenkumar2028

Copy link
Copy Markdown
Contributor

Adds a contributor guide covering prerequisites, development setup, testing, Conventional Commits, and the pull-request workflow.

Closes #39

Naveenkumar2028 and others added 2 commits August 30, 2026 19:16
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 shirshanka left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 dev for setup, aligned the prereqs with the mise-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), plus make fix and make test.

Verified every referenced target exists in the Makefile. Approving — thanks for closing this one out! 🎉

@shirshanka
shirshanka merged commit b42cde5 into datahub-project:main Sep 15, 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.

Add CONTRIBUTING.md

2 participants