6 Getting Started with Compiler Development

Joel Berkeley edited this page 2022-09-22 16:16:09 +01:00

Want to contribute to the Idris2 compiler but don't know where to start? These points should help:

• If you're new to Idris, check out the resources page for introductory material.
• Once you're familiar with using Idris, read our contributing guidelines to get an idea of how the contribution process works.
• You'll likely want to join the discord server, where people can help you get started, answer deeper questions about Idris and collaborate with you on code. The discord server has four categories:
  • USERS, for general conversation
  • HELP, for asking for help on using Idris
  • PROJECTS, for conversation about specific Idris projects
  • DEV, for conversation about working on Idris itself
• The Good first issue tag on the issue tracker indicates which issues should be easy to get started with.
• The What Contributions are Needed wiki page lays out in broad strokes the kinds of contributions that are particularly helpful.
• The map of the source code may help you find which sections of the Idris2 code base to look at when making a particular change.
• Finally, sometimes you might run into problems while working with the compiler. There is an FAQ about how to solve common issues.

• Wiki Home Page
• Using Idris
  • Resources
  • Editor Support
  • Third-party Libraries
  • External Backends
• Working on Idris
  • Getting Started
  • What Contributions are Needed
  • Map of the Source Code
  • FAQ
• Proposed changes
  • Contrib Organisation
  • The State of Idris Documentation
  • Compiler API
  • Networking Primitives
  • Types Metaprogramming Manifesto
  • TypeScript and ECMAScript interfacing
  • Modularize Machine Representation of Types