Skip to content

docs: add dedicated contributing guides - #178

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

docs: add dedicated contributing guides#178
marandaneto merged 2 commits into
mainfrom
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 build, sample, and 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

  • Added the release label to the PR
  • Added exactly one version bump label: bump-patch, bump-minor, or bump-major

@marandaneto
marandaneto requested review from a team and haacked as code owners April 17, 2026 10:01
@github-actions

github-actions Bot commented Apr 17, 2026

Copy link
Copy Markdown
Contributor

posthog-dotnet Compliance Report

Date: 2026-04-17 10:09:30 UTC
Duration: 266ms

⚠️ Some Tests Failed

0/1 tests passed, 1 failed


Feature_Flags Tests

⚠️ 0/1 tests passed, 1 failed

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

Failures

request_payload.request_with_person_properties_device_id

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

@greptile-apps

greptile-apps Bot commented Apr 17, 2026

Copy link
Copy Markdown
Contributor
Prompt To Fix All With AI
This is a comment left during a code review.
Path: CONTRIBUTING.md
Line: 50-52

Comment:
**Dropped link to `RELEASING.md`**

The old `README.md` included `For release instructions, see [RELEASING.md](RELEASING.md).` at the end of the Testing section. That line was removed but not carried into `CONTRIBUTING.md`, so release instructions are no longer reachable from any of the changed contributor-facing files. The `## Pull requests` section seems like the natural place to restore it.

```suggestion
Please follow existing conventions and include tests for your change when practical.

For release instructions, see [RELEASING.md](RELEASING.md).
```

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
@marandaneto
marandaneto enabled auto-merge (squash) April 17, 2026 10:09
@marandaneto
marandaneto merged commit 99929e9 into main Apr 17, 2026
15 checks passed
@marandaneto
marandaneto deleted the docs/add-contributing-guides branch April 17, 2026 10:38
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