stackotter/delta-client

Read if wanting to contribute

stackotter opened this issue · 0 comments

Welcome to the Delta Client project! There's plenty to do around here :)

If you want to contribute, there'll always be something that you can help out with. Even if Swift isn't your thing, you can help out with the website or documentation.

Before creating your first PR make sure to read the contributing guidelines.

Finding something to do

You can start off by looking through the issues labelled as good first issues (or just all the issues if you're feeling adventurous).

If none of the issues catch your fancy then you can try searching the code for TODO: (to search every file at once use cmd+shift+f in most IDEs). There are plenty of todos scattered around the code and some of them should be pretty approachable.

Another place you can look is Delta Client's project boards. Some of the boards aren't very up to date and some of the todos might be pretty cryptic, but you might find something that interests you.

If you want something really easy, install SwiftLint and run swiftlint --quiet inside the Delta Client repository to find all of the code-style violations in the Delta Client codebase. Even a PR that just fixes a few easy ones is welcome.

If none of that helped you find something to help out with, join the Discord server and I can help find something for you :)

Branches

Delta Client has many branches but you only need to know about a few.

  • main: features should be relatively stable and optimised before they get merged into main
  • text-rendering: not really about text rendering anymore, it's currently where I'm developing the GUI and fixing bugs. It'll be merged into main once it is more optimised
  • openssl: replaces IDZSwiftCommonCrypto with OpenSSL in anticipation of adding Linux support to the client