nim-works/nimskull

Write documentations for CGIR for developers

Aberta

#1.663 aberto em 29 de nov. de 2025

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Nim (39 forks)auto 404
compiler/backenddocumentationgood first issue

Métricas do repositório

Stars
 (346 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Estude a estrutura CGIR introduzida no PR #1625, entenda a gramática, a estrutura dos nós e a semântica operacional. Revise a discussão no Matrix para contexto. Veja a documentação IR existente (se houver) como modelo.
Pilha de tecnologia
None
Domain
compilers
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Nimcompiler concepts
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70