scribe-org/Scribe-iOS

Refactor to separate out language-specific logic

Open

#323 opened on May 31, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Swift (106 forks)auto 404
help wantedrefactor

Repository metrics

Stars
 (167 stars)
PR merge metrics
 (PR metrics pending)

Description

Terms

Issue

What? This issue is for a refactor to separate language-specific logic out from the main base keyboard functionality, generally those under Keyboards/KeyboardsBase/*.swift.

Why? Keeping the codebase cleaner and organized as code may get messy/hard-to-read with language-specific logic sprinkled around, especially as more languages are added over time (and their exceptions and quirks along with them).

How? The general initial idea is to move language-specific logic/checks into the languages' respective Keyboards/LanguageKeyboards/{language}/*.swift files. Discussion on how to implement this exactly can be done in this issue. Work can (and likely will) happen in multiple PR increments as we identify ways on how to refactor.

Other Notes:

Contributor guide

Research direction
Review the base keyboard files under Keyboards/KeyboardsBase/ and identify code that is specific to individual languages. Then move that code to the corresponding files in Keyboards/LanguageKeyboards/{language}/.
Tech stack
swift
Domain
mobile
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
SwiftGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70