-
Notifications
You must be signed in to change notification settings - Fork 17
docs: add dedicated contributing guides #178
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Contributing | ||
|
|
||
| Thanks for your interest in improving the PostHog .NET SDK. | ||
|
|
||
| ## Building | ||
|
|
||
| From the repository root, restore dependencies and build the solution: | ||
|
|
||
| ```bash | ||
| dotnet restore | ||
| dotnet build | ||
| ``` | ||
|
|
||
| ## Running samples | ||
|
|
||
| Sample projects live in the `samples` directory. | ||
|
|
||
| To run the samples, set your PostHog project API key from the repository root: | ||
|
|
||
| ```bash | ||
| bin/user-secrets set PostHog:ProjectApiKey YOUR_API_KEY | ||
| ``` | ||
|
|
||
| The main ASP.NET Core sample app can then be started with: | ||
|
|
||
| ```bash | ||
| bin/start | ||
| ``` | ||
|
|
||
| You can also run the samples from your preferred IDE or editor. | ||
|
|
||
| ## Testing | ||
|
|
||
| Run the test suite from the repository root: | ||
|
|
||
| ```bash | ||
| dotnet test | ||
| ``` | ||
|
|
||
| ### Test target frameworks | ||
|
|
||
| The test projects target both `net8.0` and `netcoreapp3.1`. While .NET Core 3.1 reached end-of-life in December 2022, we continue to test against it because: | ||
|
|
||
| - It was the first runtime to fully support .NET Standard 2.1 | ||
| - It serves as our minimum test baseline to ensure the `netstandard2.1` library works correctly on older runtimes | ||
| - It helps catch compatibility issues that might not surface on newer runtimes | ||
|
|
||
| This testing approach ensures broad compatibility without requiring users to install legacy runtimes in production. | ||
|
|
||
| ## Pull requests | ||
|
|
||
| Please follow existing conventions and include tests for your change when practical. | ||
|
|
||
| For release instructions, see [RELEASING.md](RELEASING.md). | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Contributing | ||
|
|
||
| This package contains the PostHog .NET SDK compliance adapter used with the PostHog SDK Test Harness. | ||
|
|
||
| ## Running tests | ||
|
|
||
| Tests run automatically in CI via GitHub Actions. | ||
|
|
||
| ### Locally with Docker Compose | ||
|
|
||
| Run the full compliance suite from the `sdk_compliance_adapter` directory: | ||
|
|
||
| ```bash | ||
| docker-compose up --build --abort-on-container-exit | ||
| ``` | ||
|
|
||
| This will: | ||
|
|
||
| 1. Build the .NET SDK adapter | ||
| 2. Pull the test harness image | ||
| 3. Run all compliance tests | ||
| 4. Show the results | ||
|
|
||
| ### Manually with Docker | ||
|
|
||
| ```bash | ||
| # Create network | ||
| docker network create test-network | ||
|
|
||
| # Build and run adapter | ||
| docker build -f sdk_compliance_adapter/Dockerfile -t posthog-dotnet-adapter . | ||
| docker run -d --name sdk-adapter --network test-network -p 8080:8080 posthog-dotnet-adapter | ||
|
|
||
| # Run test harness | ||
| docker run --rm \ | ||
| --name test-harness \ | ||
| --network test-network \ | ||
| ghcr.io/posthog/sdk-test-harness:latest \ | ||
| run --adapter-url http://sdk-adapter:8080 --mock-url http://test-harness:8081 | ||
|
|
||
| # Cleanup | ||
| docker stop sdk-adapter && docker rm sdk-adapter | ||
| docker network rm test-network | ||
| ``` |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.