FuelLabs/sway

Warn users if they create a package in a workspace without listing them as a member

Open

#4.451 geöffnet am 17. Apr. 2023

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Rust (5.421 Forks)batch import
ODHack13enhancementforcforc-pkggood first issuemay be rewarded

Repository-Metriken

Stars
 (61.702 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 4h) (19 gemergte PRs in 30 T)

Beschreibung

cargo warns users with a warning if they create a package inside a workspace directory like the following:

warning: compiling this new package may not work due to invalid workspace configuration

current package believes it's in a workspace when it's not:
current:   /Users/kayagokalp/fuel/dev/sway/forc-error/Cargo.toml
workspace: /Users/kayagokalp/fuel/dev/sway/Cargo.toml

We might want to do something similar. In our case a child package wouldn't be "thinking" it's in a workspace but it is still pretty easy to forget listing a package in the workspace manifest file.

Contributor Guide

Research-Richtung
Untersuche, wie cargo Warnungen für Pakete generiert, die nicht in den Workspace Mitgliedern aufgeführt sind (z. B. die Warnmeldung über eine ungültige Workspace Konfiguration). Finde dann den Code zur Workspace Verarbeitung in sway, wahrscheinlich in sway core oder ähnlichen Crates. Füge eine ähnliche Warnung hinzu, wenn ein neues Paket innerhalb eines Workspace Verzeichnisses erstellt wird, aber nicht in den [workspace] Mitgliedern in der root Cargo.toml enthalten ist. Befolge die vorhandenen Warnmuster und stelle die Kompatibilität mit der Workspace Manifest Analyse sicher.
Tech Stack
rust
Domain
tooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
RustGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75