Skip to content

Latest commit

 

History

History
46 lines (26 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

46 lines (26 loc) · 2.23 KB
Raw

How you can Contribute

Answer issues and contribute to discussions

Answering issues, participating in discussions is a great way to help, get familiar with the library, and shape its direction.

Contribute to the TootSDK codebase

Clone the main branch on your machine.

  • Open the folder in Xcode (or your preferred editor with Swift support)

Run tests

You can run tests using the Swift CLI by running swift test in the root of the project.

You can also execute tests in Xcode by switching to the Test navigator and executing one or more tests.

Please respect the existing coding style

  • Get familiar with the Swift API Design Guidelines.
  • Spaces, not tabs.
  • Whitespace-only lines are not trimmed.
  • We use SwiftLint to ensure a consistent look and feel of the library code. Your changes should contain no SwiftLint errors or warnings. Please run and check SwiftLint on any code contributions before submitting.
  • Avoid bringing in new libraries or dependencies without good justification. Any PR that brings in a new library needs to make the case for why it is necessary.

Read our Architecture Decision Records (ADRs))

All major architectural decisions are captured in our ADRs. It is worth reading these to gain context of our direction and general approach to the SDK, before writing code and submitting a PR.

Please provide documentation for your changes

All methods and types that the library makes public, should have a meaningful description and information on how to use.

It is recommended to include unit tests covering your changes.

We use Jazzy for our documentation page. To update the docs, execute ./Scripts/updatedocs.sh

Talk to the team 🤙

We'd love it if you'd talk to us over on the Fediverse! Current maintainers and admins for TootSDK are:

Open a pull request with your changes (targeting the main branch)!