scribe-org/Scribe-iOS

[Refactor] Refactor Language keyboards objects to follow SOLID principles

Open

#377 aberto em 31 de out. de 2023

Ver no GitHub
 (0 comments) (2 reactions) (0 assignees)Swift (106 forks)auto 404
help wantedrefactor

Métricas do repositório

Stars
 (167 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Terms

Description

The LanguageKeyboards group contains sub-groups for each supported languages by Scribe.

Those sub-groups contains files that exposes app level functions and enums that are all similar but are not following any strict protocol.

The end goals here would be the following:

  • Extract all the keyboards related constants into a dedicated package / framework within a common workspace file
  • Expose dedicated protocols for language keyboards that exposes the required functions and constants
  • Refactor all language keyboards to adhere to the newly created protocols
  • Refactor the Info.plist to move the constants into a single localised file and create custom Build Settings to exposes the constants to a single Info.plist file (or find another solution)
  • Extract all the common keys between keyboard to constants to avoid manually hardcoded strings
  • Add unit tests to ensure each language keyboard is working has expected

Contribution

No response

Guia do colaborador

Direção de pesquisa
Comece definindo um protocolo para teclados de idioma (ex: LanguageKeyboardProtocol) com propriedades e métodos necessários. Em seguida, refatore um teclado de idioma (ex: alemão) para estar em conformidade com o protocolo, usando o como modelo para os outros. Extraia constantes comuns para um arquivo dedicado. Considere criar um pacote SPM para constantes do teclado.
Pilha de tecnologia
swift
Domain
mobile
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
SwiftiOS developmentprotocol oriented programming
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
30