67 lines (50 loc) · 1.82 KB

Contributing to RuneScript

Thank you for your interest in contributing to RuneScript! This document outlines the process for contributing to the project.

Getting Started

Fork the repository
Clone your fork: git clone https://github.com/YOUR_USERNAME/runescript.git
Create a branch: git checkout -b feature-name
Make your changes
Test your changes
Commit your changes: git commit -m "Add feature"
Push to your fork: git push origin feature-name
Submit a pull request

Development Setup

Install Java 21 or higher
Clone the repository
The entire compiler is in src/RuneScript.java
Build with: javac src/RuneScript.java
Run with: java RuneScript [options] [file]

Project Structure

src/ - Source code and executable JAR
examples/ - Example RuneScript programs
docs/ - Documentation
README.md - Main project documentation
LICENSE - MIT License
CHANGELOG.md - Version history

Code Style

Follow Java conventions
Use meaningful variable and method names
Add comments for complex logic
Maintain the single-file structure when possible

Testing

Before submitting changes:

Test with the example files in examples/
Verify all CLI options work (--emit-tokens, --emit-ast, etc.)
Test the REPL mode
Ensure error handling works properly

Reporting Issues

When reporting issues, please include:

Java version (java -version)
Operating system
Steps to reproduce
Expected vs actual behavior
Sample code that reproduces the issue

Pull Request Guidelines

Keep PRs focused on a single feature or bug fix
Update documentation if needed
Include tests for new functionality
Follow existing code style
Reference related issues in the PR description

Questions?

Feel free to open an issue if you have questions about contributing.