This is the README for your extension "CSD". After writing up a brief description, we recommend including the following sections.
CodeShareDebugger is an AI-powered Visual Studio Code extension designed to help developers analyze and debug their code with ease. By leveraging the power of AI, it identifies code issues and suggests improvements to streamline your development process.
- 🔍 AI-Powered Code Analysis: Automatically detects bugs and offers suggestions to fix them.
- 🛠️ Easy Integration: Seamlessly integrates with Visual Studio Code, accessible right from the activity bar.
- 💡 Custom Commands: Includes a command to open the AI Code Analyzer and start analyzing code.
- 🎨 Intuitive UI: User-friendly interface to interact with the AI code analyzer.
- Clone the repository:
-
git clone https://github.com/jophex/CSD.git
- Navigate to the directory:
-
cd csd
3.Install dependencies:
```bash
npm install
4.Set up environment variables: Create a .env file at the root of the project and add your Gemin AI API key. You can get the keys from Gemin AI's official website.
API_KEY=your-gemin-ai-api-key-here
How to Use
-
Open the project in VSCode: You can open this project or any other project in Visual Studio Code.
-
Run the extension: Press F5 to start the extension in debug mode. This will open a new window with your extension enabled.
-
Start analyzing code: Open any project within this new window. You will see an icon that resembles a chip (AI Code Analyzer) in the activity bar. Click on it, then press "Open AI Code Analyzer" to start debugging your code with AI assistance.
Contributing
We welcome contributions to CodeShareDebugger! Here are some guidelines if you're interested:
-
Fork the repository to make your changes.
-
Create a new branch for your feature or bug fix
git checkout -b feature/your-feature-name
-
Commit your changes with clear messages
``bash
git commit -m "Add feature: Your feature description" -
Push to your branch
git push origin feature/your-feature-name
-
Submit a pull request.
Contribution Rules: -Please make sure to include tests for your features. -Follow the project's coding style. -Ensure all pull requests are related to a GitHub issue.
*License This project is licensed under the MIT License - see the LICENSE file for details.
Contact If you have any questions or feedback, feel free to reach out via GitHub issues or directly contribute to the project!
🔗 GitHub Repo: Your GitHub Link