Open Source
Contribute to Rey
Rey is open source and welcoming contributors. Whether you're fixing a typo or implementing a major feature, every contribution matters.
Process
How to get started
1
Fork and clone
Fork the repository on GitHub, then clone your fork locally.
$ git clone https://github.com/YOUR_USERNAME/rey-lang
2
Set up the dev environment
You need Rust (1.70+) and LLVM installed. Then build the compiler:
$ cd compiler/v1 && cargo build
3
Run the tests
Make sure all tests pass before making changes:
$ cargo test
4
Make your changes
Create a new branch, make changes, add tests if relevant.
$ git checkout -b feat/my-feature
5
Submit a PR
Push your branch and open a pull request. Describe what it does and why.
$ git push origin feat/my-feature
Help needed
Areas to contribute
Concrete areas where Rey needs work. Pick what interests you.
🔧High impact
Compiler
- →Improve error messages with better span information
- →Add missing operator support (++, --, bitwise ops)
- →Implement generics in the type system
- →Optimize the LLVM IR emission pass
- →Add a proper incremental compilation model
📚High impact
Standard Library
- →Expand String methods (indexOf, slice, format)
- →Add a File type with streaming read/write
- →Implement a math module (min, max, abs, pow)
- →Add networking primitives
- →Write comprehensive stdlib tests
🌐Medium impact
Platform Support
- →Linux x86_64 port
- →Linux arm64 port
- →Windows x86_64 port (via LLVM MinGW)
- →CI/CD for cross-platform builds
- →Package manager integration
📝Good for beginners
Documentation
- →Write more code examples for the reference
- →Add a "Rey by Example" guide section
- →Document the compiler internals
- →Fix typos and clarify confusing sections
- →Translate the getting started guide
🧪Good for beginners
Testing
- →Add more E2E test cases (currently 11 passing)
- →Write unit tests for the lexer and parser
- →Add fuzz testing for the parser
- →Set up a test suite for the stdlib
- →Create regression tests for fixed bugs
🔍Medium impact
Tooling
- →VS Code syntax highlighting extension
- →LSP server for code intelligence
- →A repl (read-eval-print loop)
- →Code formatter
- →Linter with common mistake detection
Code of Conduct
Rey is a welcoming, inclusive project. We expect all contributors to:
- Be respectful and considerate in all communications
- Welcome contributions from people of all backgrounds and skill levels
- Focus on constructive feedback and solutions
- Respect maintainer decisions, even when you disagree
- Keep discussions on-topic and productive
Harassment, discrimination, or any form of disrespectful behavior will result in removal from the project.