Contributing Guide

Contributing Guide

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to AutomataLab and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Development Setup

1. Prerequisites: Ensure you have Node.js and Rust installed on your machine.
2. Clone the repository:

   git clone https://github.com/reeshavsinha/AutomataLab.git
   cd AutomataLab

3. Install Dependencies:

   npm install

4. Run Development Server:

   npm run tauri:dev

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

• Check if the bug has already been reported.
• Use the provided Bug Report issue template.
• Provide clear steps to reproduce.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion.

• Use the provided Feature Request issue template.
• Describe the current behavior and the behavior you'd like to see.
• Explain why this enhancement would be useful.

Pull Requests

• Fill in the required template.
• Do not include issue numbers in the PR title.
• Include screenshots and animated GIFs in your pull request whenever possible to demonstrate UI changes.
• Ensure all tests and the build pass before requesting a review.