Skip to content

docs: add dedicated contributing guides#521

Merged
marandaneto merged 2 commits intomainfrom
docs/add-contributing-guides
Apr 17, 2026
Merged

docs: add dedicated contributing guides#521
marandaneto merged 2 commits intomainfrom
docs/add-contributing-guides

Conversation

@marandaneto
Copy link
Copy Markdown
Member

💡 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.md files so contributors have a consistent place to find local setup and adapter test instructions.

💚 How did you test it?

  • Not run (docs-only changes)
  • Checked the updated markdown links and file locations

📝 Checklist

  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • I updated the docs if needed.
  • No breaking change or entry added to the changelog.

If releasing new changes

  • Ran sampo add to generate a changeset file
  • Added the release label to the PR

@marandaneto marandaneto requested a review from a team as a code owner April 17, 2026 10:01
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 17, 2026

Prompt To Fix All With AI
This 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 thread CONTRIBUTING.md Outdated
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
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.

P2 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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 17, 2026

posthog-python Compliance Report

Date: 2026-04-17 10:09:57 UTC
Duration: 160015ms

✅ All Tests Passed!

30/30 tests passed


Capture Tests

29/29 tests passed

View Details
Test Status Duration
Format Validation.Event Has Required Fields 517ms
Format Validation.Event Has Uuid 1507ms
Format Validation.Event Has Lib Properties 1507ms
Format Validation.Distinct Id Is String 1507ms
Format Validation.Token Is Present 1507ms
Format Validation.Custom Properties Preserved 1507ms
Format Validation.Event Has Timestamp 1507ms
Retry Behavior.Retries On 503 9517ms
Retry Behavior.Does Not Retry On 400 3505ms
Retry Behavior.Does Not Retry On 401 3508ms
Retry Behavior.Respects Retry After Header 9515ms
Retry Behavior.Implements Backoff 23528ms
Retry Behavior.Retries On 500 7504ms
Retry Behavior.Retries On 502 7511ms
Retry Behavior.Retries On 504 7509ms
Retry Behavior.Max Retries Respected 23521ms
Deduplication.Generates Unique Uuids 1508ms
Deduplication.Preserves Uuid On Retry 7515ms
Deduplication.Preserves Uuid And Timestamp On Retry 14520ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry 7504ms
Deduplication.No Duplicate Events In Batch 1508ms
Deduplication.Different Events Have Different Uuids 1506ms
Compression.Sends Gzip When Enabled 1507ms
Batch Format.Uses Proper Batch Structure 1506ms
Batch Format.Flush With No Events Sends Nothing 1005ms
Batch Format.Multiple Events Batched Together 1505ms
Error Handling.Does Not Retry On 403 3509ms
Error Handling.Does Not Retry On 413 3507ms
Error Handling.Retries On 408 7514ms

Feature_Flags Tests

1/1 tests passed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id 515ms

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@marandaneto marandaneto enabled auto-merge (squash) April 17, 2026 10:06
@marandaneto marandaneto merged commit fe12309 into main Apr 17, 2026
26 checks passed
@marandaneto marandaneto deleted the docs/add-contributing-guides branch April 17, 2026 10:37
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