Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (68 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

106 lines (68 loc) · 2.29 KB
Raw

Contributing to KemLang

🎉 Kem Cho! Thank you for your interest in contributing to KemLang!

KemLang is a fun, Gujarati-inspired toy programming language. Whether you're here to fix bugs, add features, improve documentation, or just explore—you're welcome!

🧭 Where to Start

  1. Check Issues

    • Look for issues labeled good first issue, help wanted, or bug.
    • If something is unclear or missing, feel free to open a new issue.

  2. Join Discussions

    • Head over to the Discussions tab.
    • Share ideas, give feedback, or ask questions.

  3. Play with KemLang

    • Try writing your own Gujarati-inspired scripts using sharu, lakho, samaapt.
    • Report unexpected behavior or suggest new features.

⚙️ Local Setup

To get started locally:

# Clone the repo
$ git clone https://github.com/pritpatel2412/kemlang.git

# Navigate to the backend folder
$ cd kemlang/kemlang-backend

# (Optional) Set up a virtual environment
$ python -m venv venv
$ source venv/bin/activate  # or venv\Scripts\activate on Windows

# Install dependencies
$ pip install -r requirements.txt

# Run the CLI
$ python cli.py

For the frontend (React):

# Navigate to the frontend folder
$ cd ../kemlang-frontend

# Install dependencies
$ npm install

# Run the development server
$ npm run dev

🚀 Submitting a Contribution

  1. Fork the Repo

  2. Create a Branch

    git checkout -b fix/my-cool-fix

  3. Commit Your Changes

    git commit -m "fix: fix something awesome"

  4. Push to Your Fork

    git push origin fix/my-cool-fix

  5. Open a Pull Request (PR)

🧼 Code Style & Standards

  • Use meaningful commit messages.
  • Keep your code readable and documented.
  • Write comments in English or Gujarati (but no swearing 😄).
  • If updating the UI, test it on desktop browsers (laptop view preferred).

💬 Need Help?

Open an issue or ping us in discussions. No question is too small or silly. We’re all learning.

🙌 Thank You!

Your contributions make KemLang better! Whether it’s code, docs, ideas, or feedback—you’re helping build a desi-cool experience for everyone.

Bhau, KemLang ma toh maja avi gayi! 😄