Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 1.68 KB

Overview

Hi there, thanks for your interest. Currently I am the sole maintainer for this project but I am more than happy if this changes 😊

I welcome any contribution, not only code. You can help

  • 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 me 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 me know!

Submitting code and pull request handling

Submit all code contributions via Pull Requests (PRs). PRs shall target the dev branch.

Code changes shall not degrade the code coverage or CodeBeat rating.

Quick checklist summary before submitting a PR:

  • 🔎 Make sure tests are added or updated to accommodate your changes.
  • 👌 Verify that tests pass, code is free of SwiftLint violations, and code is formatted accordingly to project rules (.swiftformat).
  • 📖 Check that your commit message follows Conventional Commit standards and has a meaningful description of what it is about
  • 👍 Push it!

I reserve the right to close or to not process pull requests.