Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (42 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 1.48 KB

🤝 Contributing to CodeCharm

Welcome, fellow dev! 💻
Thanks for your interest in contributing to CodeCharm, the AI-powered inline code-commenting extension for VS Code. Whether you're here to squash bugs, add features, or polish up documentation — you're awesome 🔥

🛠️ Local Setup

  1. Clone the repo 
    git clone https://github.com/DeveloperPuneet/CodeCharm.git
cd CodeCharm
Install dependencies
npm install
Create .env file
  2. env 
     API=your_gemini_api_key_here

Open in VS Code & run

Press F5 to open a new Extension Development Host window.

Select some code in any file.

Press Ctrl + Win + J to generate inline comments 🧠✨

📦 Folder Structure

CodeCharm/
├── src/                  # Extension logic
├── .vscode/              # Launch config
├── .env                  # API key (not committed)
├── package.json          # VS Code extension metadata
├── README.md             # Main doc
└── CONTRIBUTING.md       # This file!
  1. 🧪 Want to Contribute? Here’s how:

🐞 Found a bug? Open an issue

🌟 Got a feature idea? Create a feature request

🛠️ Fix something? Fork, branch, commit, PR like a legend

  1. 💡 Code Guidelines Keep it clean and modular

Use async/await for API logic

Never commit .env or API keys

Follow emoji + inline comment vibe

  1. 🙏 Thanks You're literally making coding better for thousands. Now go Whiz some code! 💫