docs: add dedicated contributing guides#521
Merged
marandaneto merged 2 commits intomainfrom Apr 17, 2026
Merged
Conversation
Contributor
Prompt To Fix All With AIThis is a comment left during a code review.
Path: CONTRIBUTING.md
Line: 33-34
Comment:
**Broken activate path in recommended workflow**
`uv venv` (no arguments) creates `.venv/` by default, not `env/`. The `source env/bin/activate` line will fail with "No such file or directory" because the directory is `.venv`, not `env`. Either pass an explicit name to match, or update the activate path.
```suggestion
uv venv
source .venv/bin/activate
```
How can I resolve this? If you propose a fix, please make it concise.
---
This is a comment left during a code review.
Path: CONTRIBUTING.md
Line: 55
Comment:
**Incorrect TOML table key in `pyproject.toml` example**
The correct uv configuration key is `[tool.uv.sources]`, not `[tools.uv.sources]`. With the `s` suffix, uv silently ignores the entire section, so the path override would have no effect.
```suggestion
[tool.uv.sources]
```
How can I resolve this? If you propose a fix, please make it concise.
---
This is a comment left during a code review.
Path: sdk_compliance_adapter/CONTRIBUTING.md
Line: 24-32
Comment:
**Missing working directory note for "Manually with Docker"**
The `docker build` command uses `-f sdk_compliance_adapter/Dockerfile` with a repo-relative path, so it must be run from the **repository root**, not from `sdk_compliance_adapter/` as the Docker Compose section instructs. A brief comment (or a prose note matching the one above) would prevent confusion.
How can I resolve this? If you propose a fix, please make it concise.Reviews (1): Last reviewed commit: "docs: add contributing guides" | Re-trigger Greptile |
Comment on lines
+24
to
+32
| ### Manually with Docker | ||
|
|
||
| ```bash | ||
| # Create network | ||
| docker network create test-network | ||
|
|
||
| # Build and run adapter | ||
| docker build -f sdk_compliance_adapter/Dockerfile -t posthog-python-adapter . | ||
| docker run -d --name sdk-adapter --network test-network -p 8080:8080 posthog-python-adapter |
Contributor
There was a problem hiding this comment.
Missing working directory note for "Manually with Docker"
The docker build command uses -f sdk_compliance_adapter/Dockerfile with a repo-relative path, so it must be run from the repository root, not from sdk_compliance_adapter/ as the Docker Compose section instructs. A brief comment (or a prose note matching the one above) would prevent confusion.
Prompt To Fix With AI
This is a comment left during a code review.
Path: sdk_compliance_adapter/CONTRIBUTING.md
Line: 24-32
Comment:
**Missing working directory note for "Manually with Docker"**
The `docker build` command uses `-f sdk_compliance_adapter/Dockerfile` with a repo-relative path, so it must be run from the **repository root**, not from `sdk_compliance_adapter/` as the Docker Compose section instructs. A brief comment (or a prose note matching the one above) would prevent confusion.
How can I resolve this? If you propose a fix, please make it concise.
Contributor
posthog-python Compliance ReportDate: 2026-04-17 10:09:57 UTC ✅ All Tests Passed!30/30 tests passed Capture Tests✅ 29/29 tests passed View Details
Feature_Flags Tests✅ 1/1 tests passed View Details
|
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
dustinbyrne
approved these changes
Apr 17, 2026
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.
💡 Motivation and Context
This repo had contributor-facing development instructions split between the root README and the SDK compliance adapter README.
This PR moves that guidance into dedicated
CONTRIBUTING.mdfiles so contributors have a consistent place to find local setup and adapter test instructions.💚 How did you test it?
📝 Checklist
If releasing new changes
sampo addto generate a changeset filereleaselabel to the PR