Thank you so much for being so interested in contributing to our project! It's people like you that make the open source community such a great community! 😊
We welcome any contribution, not only code. You can help and
- analyze issues: take a look at the open issues. Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
- report an issue: do not hesitate to file a new issue. Do not hesitate to provide as many details as possible.
- provide feedback: is the README insufficient, or is the API documentation unclear? Let us know!
Submit all code contributions via Pull Requests (PRs). PRs shall target the dev
branch.
Quick checklist summary before submitting a PR:
- 🔎 Make sure tests are added or updated to accommodate your changes. When possible, add tests to verify bug fixes and prevent future regressions. For SwiftUI code changes, please add or improve SwiftUI Previews
- 👌 Verify that tests pass (
make test
andmake uitest
), code is free of SwiftLint violations (make lint
), and code is formatted accordingly to project rules (make format
)- Install required tools for linting and formatting with
make devtools
- Install required tools for linting and formatting with
- 📖 Check that your commit message follows Conventional Commit standards and has a meaningful description of what it is about
- 👍 Push it!
We reserve the right to close pull requests (without processing).
Due to legal reasons, contributors will be asked to accept a DCO before accepting their first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.