🧿codemetry

About The Project

A simple VSCode extension to generate comments for Code Snippets.

Installation

1. Get a free API Key at https://openai.com
2. Clone the repo

   git clone https://github.com/msris108/codemetry.git

3. Install NPM packages

   yarn install

Usage

Command List

    ctrl + shift + P : codemetry > Generate Comments
    ctrl + shift + P : codemetry > Set API key

Requirements

• Get API keys from OpenAI
• Set the API Key

1. Set API Key before code generation
2. Select a small snippet; preferably 1000 characters
3. Generate Comments

Roadmap

• Add Changelog
• Multi-language Support
• Create a AI coding companion

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @msris108 - [email protected]

Project Link: https://github.com/msris108/codemetry