From 8c5e8e57db3df2160678c9bed3b805a4411a69b8 Mon Sep 17 00:00:00 2001 From: M Naveenkumar Date: Sun, 30 Aug 2026 19:16:49 +0530 Subject: [PATCH 1/2] docs: add contributing guide --- CONTRIBUTING.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3fcd34a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Thank you for your interest in contributing to Analytics Agent! + +## Prerequisites + +Before starting development, make sure you have: + +- Python 3.11 or newer +- `uv` +- Node.js 20 or newer +- `pnpm` + +## Development setup + +1. Fork the repository and clone your fork. +2. Create a feature branch from `main`. +3. Follow the development setup described in `README.md`. +4. Install the project dependencies using the repository's documented `make install` (or equivalent manual) steps. +5. Start the development environment using the documented `make dev` command or equivalent manual steps. + +## Running tests + +Run the project's test suite before opening a pull request. Follow the test commands documented in `README.md` and make sure the checks relevant to your change pass locally. + +If you add or modify behavior, include appropriate tests when practical. + +## Commit messages + +This project uses Conventional Commits. Keep commit messages concise and use an appropriate type, for example: + +```text +feat: add analytics filter +fix: handle missing connector data +docs: clarify local development setup +chore: update dependencies +``` + +## Pull request process + +1. Create a focused branch for your change. +2. Keep the change small and related to one problem. +3. Run relevant tests and checks locally. +4. Use a clear PR title and description explaining what changed and why. +5. Link the relevant issue when applicable. +6. Be responsive to review feedback and update the branch as needed. +7. Wait for CI checks and maintainer review before merging. + +## Good first contributions + +Documentation improvements, tests, bug fixes, and small usability improvements are all welcome. If you are unsure where to start, look for issues labeled `good first issue` or `documentation`. + +## Questions + +For questions about contributing or the development environment, please use the repository's existing issue and discussion channels. From 361004b4fe08cb1f1249453cd49307c2cf97ce53 Mon Sep 17 00:00:00 2001 From: Shirshanka Das Date: Tue, 15 Sep 2026 04:57:57 -0700 Subject: [PATCH 2/2] docs: use the repo's real commands in CONTRIBUTING.md 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 Claude-Session: https://claude.ai/code/session_01Wn2yUdhpmxqew5Jb4NrMcR --- CONTRIBUTING.md | 52 +++++++++++++++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fcd34a..895f7bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,28 +6,43 @@ Thank you for your interest in contributing to Analytics Agent! Before starting development, make sure you have: -- Python 3.11 or newer -- `uv` -- Node.js 20 or newer -- `pnpm` +- Python 3.11+ +- [`uv`](https://docs.astral.sh/uv/getting-started/installation/) +- [`mise`](https://mise.jdx.dev/getting-started.html) — manages Node and `pnpm` (reads `.mise.toml`) ## Development setup 1. Fork the repository and clone your fork. 2. Create a feature branch from `main`. -3. Follow the development setup described in `README.md`. -4. Install the project dependencies using the repository's documented `make install` (or equivalent manual) steps. -5. Start the development environment using the documented `make dev` command or equivalent manual steps. +3. Install dependencies: + ```bash + mise install # installs Node + pnpm from .mise.toml + make install # uv sync + pnpm install + ``` +4. Start the development environment: + ```bash + make dev # hot-reload backend (use `make dev-full` for frontend HMR too) + ``` -## Running tests +See the **Manual setup (for contributors / development)** section of `README.md` for full detail (first-time setup, `.env`, connecting DataHub), and `make help` for all available targets. -Run the project's test suite before opening a pull request. Follow the test commands documented in `README.md` and make sure the checks relevant to your change pass locally. +## Running tests and checks -If you add or modify behavior, include appropriate tests when practical. +Before opening a pull request: + +```bash +make test # unit tests +make lint # ruff + format + mypy — mirrors CI; must pass +``` + +- `make fix` auto-fixes lint and formatting issues. +- `make test-integration` runs the integration suite (needs credentials in `.env`). + +If you add or change behavior, include tests when practical. ## Commit messages -This project uses Conventional Commits. Keep commit messages concise and use an appropriate type, for example: +This project uses [Conventional Commits](https://www.conventionalcommits.org/). Keep messages concise and use an appropriate type, for example: ```text feat: add analytics filter @@ -38,13 +53,12 @@ chore: update dependencies ## Pull request process -1. Create a focused branch for your change. -2. Keep the change small and related to one problem. -3. Run relevant tests and checks locally. -4. Use a clear PR title and description explaining what changed and why. -5. Link the relevant issue when applicable. -6. Be responsive to review feedback and update the branch as needed. -7. Wait for CI checks and maintainer review before merging. +1. Keep the change focused and related to one problem. +2. Run `make test` and `make lint` locally — CI runs the same checks. +3. Use a clear PR title (Conventional Commits style) and describe what changed and why. +4. Link the relevant issue when applicable (e.g. `Closes #123`). +5. Be responsive to review feedback and update the branch as needed. +6. Wait for CI checks and maintainer review before merging. ## Good first contributions @@ -52,4 +66,4 @@ Documentation improvements, tests, bug fixes, and small usability improvements a ## Questions -For questions about contributing or the development environment, please use the repository's existing issue and discussion channels. +For questions about contributing or the development environment, please open an issue or start a discussion.