Contributing

Welcome to Odialang! We appreciate your interest in contributing.

Ways to Contribute

Code Contributions

Help implement new features, fix bugs, or improve the compiler.

Documentation

Improve tutorials, add examples, or fix typos in docs.

Examples

Create new example programs to help others learn.

Feedback

Report bugs, suggest features, or share your experience.

Getting Started

1

Fork the Repository

Click the 'Fork' button on GitHub to create your own copy.

2

Clone Your Fork

git clone https://github.com/YOUR_USERNAME/Odialang.git
3

Install Dependencies

npm install
4

Create a Branch

git checkout -b feature/your-feature-name
5

Make Changes

Implement your feature or fix the bug.

6

Test Your Changes

npm test
7

Commit and Push

git add .
git commit -m "Description"
git push
8

Create a PR

Go to GitHub and create a pull request.

Code Style

  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused
  • Follow existing indentation style
  • Use TypeScript for new code

Project Structure

src/
├── lexer/   # Tokenizer
├── parser/  # Parser
├── codegen/  # Code generator
└── cli/    # Command line interface

Need Help?

Open an issue on GitHub or ask questions in discussions.

Thank You!

Thank you for contributing to Odialang! Every contribution helps make this project better.