PLC-lang/rusty

Create utility workspace with macros for all internal naming conventions

オープン

#913 opened on 2023/07/18

GitHub で見る
 (1 件のコメント) (0 件のリアクション) (0 人の担当者)Rust (71 件のフォーク)auto 404
good first issuelow-priorityrefactor

Repository metrics

Stars
 (351 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド

調査方針
リンクされたコードスニペットを確認し、一般的な命名規則パターンを特定してから、新しい 'util' crate を作成し、マクロを使ってこれらの規則を1か所で定義します。ワークスペース全体でそれらを公開する方法を検討してください。
技術スタック
rust
領域
backend
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
RustCargo workspaces
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50