nim-works/nimskull

Write documentations for CGIR for developers

Offen

#1.663 geöffnet am 29.11.2025

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Nim (39 Forks)auto 404
compiler/backenddocumentationgood first issue

Repository-Metriken

Stars
 (346 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

We need a document describing and helping developers work with the new CGIR introduced in #1625.

In particular, these points should be covered:

  • Grammar and node structure
  • Operational semantics
  • Places to look at to get an understanding on how to manipulate the code.

A brief discussion was done on Matrix and can be found here.

Contributor Guide

Research-Richtung
Studieren Sie die in PR #1625 eingeführte CGIR Struktur, verstehen Sie die Grammatik, Knotenstruktur und operationale Semantik. Überprüfen Sie die Matrix Diskussion für Kontext. Schauen Sie sich vorhandene IR Dokumentation (falls vorhanden) als Vorlage an.
Tech Stack
Keine
Domain
compilers
Issue Type
Dokumentation
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.
1-3 Stunden
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
Nimcompiler concepts
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70