nim-works/nimskull

Write documentations for CGIR for developers

Ouverte

#1 663 ouverte le 29 nov. 2025

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Nim (39 forks)auto 404
compiler/backenddocumentationgood first issue

Métriques du dépôt

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

Description

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.

Guide contributeur

Direction de recherche
Étudiez la structure CGIR introduite dans la PR #1625, comprenez la grammaire, la structure des nœuds et la sémantique opérationnelle. Consultez la discussion Matrix pour le contexte. Regardez la documentation IR existante (le cas échéant) comme modèle.
Stack technique
Aucun
Domaine
compilers
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
Nimcompiler concepts
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70