Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.39 KB

Contributing Guide

Thank you for considering contributing to Javascomp! The goal of this project is to create a safer and friendlier JavaScript compiler. Any help is welcome, whether it's fixing bugs, improving documentation, or proposing new features.

How to Contribute

1. Reporting Bugs

If you find an error, please open an Issue on GitHub detailing:

  • What you were trying to do.
  • The code that caused the error.
  • The expected behavior vs. the actual behavior.
  • Information about your environment (OS, Rust version, etc.).

2. Proposing Changes (Pull Requests)

  1. Fork the repository.
  2. Create a Branch for your feature or fix: git checkout -b my-new-feature.
  3. Make your changes and commit: git commit -m 'Add new feature X'.
  4. Push to your fork: git push origin my-new-feature.
  5. Open a Pull Request to the main branch of this repository.

Code Guidelines

  • This project is written in Rust. Please follow standard language style conventions (rustfmt).
  • Write clean and readable code. Remember the focus is on being beginner-friendly, and this applies to the compiler code as well.
  • Add tests for new features whenever possible.

Code of Conduct

Please note that this project has a Code of Conduct. By participating, you are expected to respect these guidelines to maintain a healthy and inclusive environment.