Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (67 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

89 lines (67 loc) · 3.38 KB

Contributing to Thaw

The following is a set of guidelines to contribute to Thaw on GitHub. Feel free to propose any changes to this document. All contributions welcome.

Code of Conduct

Please read and follow our Code of Conduct.

Ways to contribute

  • Bug reports
  • Documentation improvements
  • Code
  • Translations

Before You Start

Regardless of the type of contribution, you'll need a GitHub account and a fork of the repository:

  1. Fork the repository on GitHub
  2. Clone your fork locally
git clone https://github.com/YOUR_USERNAME/Thaw.git
  1. Navigate to the cloned directory
  2. Create a branch for your changes
git checkout -b your-branch-name
  1. When ready, open a pull request against stonerl/Thaw:main

Non-technical contributions

Reporting bugs

Before submitting a bug report, please search the issue tracker and check Frequent Issues — your problem may already be known with a workaround available.

We want to fix all issues as soon as possible, but before fixing a bug we need to be able to reproduce them first. Our bug report template will guide you through the information we need. Issues without enough information to reproduce the problem may be closed until more details are provided.

If the app crashed — attaching a log file will help us significantly, you can find these in Thaw's settings under the General tab.

Translations

If you want to help translate Thaw into your language or improve existing ones, head over to Crowdin and start contributing.

Documentation improvements

If you find something unclear, incomplete, or out of date in any of the project's docs, a pull request to fix it is welcome.

This includes but is not limited to:

  • Fixing typos or unclear wording
  • Keeping the README up to date
  • Adding new entries to Frequent Issues
  • Improving this and other guides.

Technical contributions

Prerequisites

  • Xcode 16.4+
  • macOS 14+

Getting Started

  1. Open Thaw.xcodeproj in Xcode 16.4 or later
open Thaw.xcodeproj
  1. Build and run the app (Cmd+R) to confirm everything works before making changes

Code Style

Thaw uses SwiftLint and SwiftFormat to enforce consistent code style.

Before submitting a request, run:

swiftformat .
swiftlint lint

Pull requests are automatically reviewed by SonarCloud for code quality and CodeRabbit for AI-assisted review. You may receive automated comments from these tools, so please address any findings before requesting a human review.

Pull Requests

Open a pull request via the Thaw pull requests page and select the appropriate template — it will guide you through the required information and checklist.

Resources