Contributing

First off, thank you for considering contributing to Then! It's thanks to people like you that the project thrives.

Our vision for Then is to simplify Swift async code on all platforms running Swift code. We are very open to contributions and any ideas that can improve the project!

How to Contribute

There are several ways you can contribute:

  • Report a bug: If you find a bug or strange behavior, please open an issue.
  • Suggest a new feature: Have an idea for a new helper or an improvement? Let's discuss it in an issue.
  • Open a pull request: If you want to contribute code, that's fantastic!

To maximize the chance of your pull request being approved, we recommend opening an issue first. This allows us to discuss the proposed change or addition so that you don't waste time on a feature that might be rejected later.

Development Setup

  1. Fork the repository on GitHub.
  2. Clone your fork locally: git clone https://github.com/YOUR_USERNAME/Then.git
  3. Open the Package.swift file in Xcode.
  4. Create a new branch for your feature or bug fix: git checkout -b my-awesome-feature.

Running Tests

When you submit a change, please ensure that all unit tests pass. You can run the tests in Xcode by pressing Cmd+U.

When adding a new feature, it's best if you can also add corresponding unit tests. If you're new to this, no problem! The team can help you or add the unit tests for you.