Contributing

June 16, 2026 · View on GitHub

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.

We follow the conventional commits specification for our commit messages:

fix: bug fixes, e.g. fix crash due to deprecated method.
feat: new features, e.g. add new method to the module.
refactor: code refactor, e.g. extract a helper or restructure a plugin in the Timeline.
docs: changes into documentation, e.g. add usage example for the module.
test: adding or updating tests, e.g. add XCTest cases under Tests/Segment-Tests for a new flush policy.
chore: tooling changes, e.g. change CI config.

Please format your commit messages this way; maintainers may ask you to amend commits that don't follow the convention.

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

When you're sending a pull request:

Prefer small pull requests focused on one change.
Verify that linters and tests are passing.
Review the documentation to make sure it looks good.
Follow the pull request template when opening a pull request.
For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.