Nanyx
PlaygroundPackages

Compiler workstreams

How work on the compiler and its tools is split up, labelled and tracked

The pages from here to the end of this section are the design of the compiler and its tools: what is planned, what is decided and what is still open. How they work today is in the Deep dives section. Both change as the work does. Anyone who changes something one of them describes updates the page in the same pull request.

Work on the compiler and its tools is split into workstreams. Each has a page and a label on its issues. There are no tracking issues. The Nanyx workstreams project holds every open issue on one board. Its Stream field places an issue in the workstream it mostly serves. Its Stage field, set on each issue, orders the backlog:

  • Working set: being worked now, and taken first. An issue whose Status is In Progress is always in the Working set: claiming an issue moves it there.
  • Ready: fully specified, with a “done when” and nothing left to decide, so anyone can pick it up.
  • Planning: still has open questions, or is a draft with no “done when”. It isn’t worked until its questions are settled and it moves to Ready.
WorkstreamDesignLabel
CompilationCompilationcompilation
LintersLinters: compiler designlinters
Error messagesError messageserror messages
Language server and editorLanguage server and editorlsp
PackagingPackagingpackaging
FormatterFormatterformatting
RefactoringsRefactoringsrefactoring
Code quality—code quality

The compilation workstream has pages of its own for the larger pieces of its design: the parser, deferred errors, tail calls, memory management, inlining and lazy sequences. How the standard library is built is in Standard library implementation, and how the CLI is built in The nanyx command; what the CLI does is on The nanyx command.

An issue that serves more than one workstream gets every label that applies. The finer labels (parser, type checker, wasm backend) say which part of the compiler an issue is in, and are used alongside the workstream label.