Skip to content

docs: align contributing guides with CI checks #132

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.

Sign up for GitHub

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
marandaneto merged 1 commit into from
Apr 17, 2026
Merged

docs: align contributing guides with CI checks #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,14 @@ Thanks for your interest in improving the PostHog Ruby SDK.
ruby example.rb
```

## Testing
## CI-aligned checks

1. Run the full test suite:
Run the same checks CI uses before opening a PR:

```bash
bin/test
```

2. Run a specific test if needed:

```bash
bin/test spec/posthog/client_spec.rb:26
```
```bash
bundle exec rspec
bundle exec rubocop
```

## Rails package

Expand Down
6 changes: 3 additions & 3 deletions posthog-rails/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ This guide covers package-specific development for `posthog-rails`.

For repository-level setup, see the root [CONTRIBUTING.md](../CONTRIBUTING.md).

## Development
## CI-aligned checks

Run the package tests from the repository root:
Run the same checks CI uses before opening a PR:

```bash
bundle install
bundle exec rspec
bundle exec rubocop
```

## Pull requests
Expand Down
Loading