PLC-lang/rusty

Create utility workspace with macros for all internal naming conventions

Ouverte

#913 ouverte le 18 juil. 2023

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)Rust (71 forks)auto 404
good first issuelow-priorityrefactor

Métriques du dépôt

Stars
 (351 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

We have several naming conventions that are defined across the project (e.g. internally generated types). Since we split the project into workspaces we keep having problems for finding a single place to define functions/macros for these naming conventions, so they are visible to anybody.

I suggest creating its own crate for utility functions called 'util' and we start with offering macros for all kinds of naming-convention-macros:

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/index.rs#L1489-L1492

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/typesystem.rs#L1273-L1277

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/ast/pre_processor.rs#L162

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/ast/pre_processor.rs#L189

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/resolver/generics.rs#L207

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/resolver/generics.rs#L439

Guide contributeur

Direction de recherche
Examinez les extraits de code liés pour identifier les modèles de conventions de nommage courants, puis créez une nouvelle crate 'util' avec des macros pour définir ces conventions en un seul endroit. Réfléchissez à la manière de les exposer entre les espaces de travail.
Stack technique
rust
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
RustCargo workspaces
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50