Skip to content

Latest commit

 

History

History
129 lines (90 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

129 lines (90 loc) · 3.06 KB

Contributing to SimpleScript

Thank you for considering contributing to SimpleScript! This project is an educational and developer-friendly scripting language built using JavaScript. It features a lexer, parser, and interpreter along with a fully interactive web interface.

We welcome contributions from everyone—whether you're a beginner or an experienced developer. Your help makes SimpleScript better for all users.

Table of Contents

Getting Started

  1. Fork the repository to your GitHub account.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/simple-script.git
cd simple-script
  3. Install any dependencies (if applicable): 
    npm install
  4. Start the development server: 
    npm run dev

How to Contribute

There are several ways you can contribute to SimpleScript:

  • Improve the lexer, parser, or interpreter
  • Add support for new keywords, functions, or data types
  • Improve or refactor the frontend UI/UX
  • Write unit tests or example scripts
  • Enhance or fix documentation
  • Report and fix bugs

Project Structure

  • lexer/ – Token generation logic
  • parser/ – Grammar and syntax rules
  • interpreter/ – Execution logic
  • web/ – HTML, CSS, and JavaScript interface
  • docs/ – Language documentation and examples

Coding Guidelines

  • Follow consistent naming conventions
  • Keep functions small and focused
  • Comment complex logic for clarity
  • Write clean, readable code
  • Run tests and verify functionality before pushing

Pull Request Process

  1. Create a new branch: 
    git checkout -b feature/your-feature-name
  2. Make your changes and commit them with meaningful messages.
  3. Push the branch to your forked repo: 
    git push origin feature/your-feature-name
  4. Open a pull request with:
    • Clear title
    • Detailed description
    • Screenshots or test results if applicable

Feature Suggestions

Want to see something added to SimpleScript? Open an issue labeled enhancement and describe your idea in detail.

Reporting Bugs

If you find a bug, please:

  1. Check if it’s already reported.
  2. Create a new issue with steps to reproduce.
  3. Include screenshots, logs, or error messages if possible.

Community Standards

  • Be respectful and constructive
  • Encourage beginners and help others learn
  • No harassment, discrimination, or spam

See our Code of Conduct for full details.

License

SimpleScript is open-source and available under the MIT License.

Let’s build something amazing—together!

Happy Coding!
— The SimpleScript Team