armelgeek / code-reporter

Code Reporter is a Visual Studio Code extension that allows you to create code reports with descriptions and tasks.

Code Reporter

Description

Code Reporter is a Visual Studio Code extension that allows you to create code reports with descriptions and tasks.

Features

• Generate code reports with file links, descriptions, and code snippets.
• Organize reports by year, month, week, and day.
• Track tasks and their completion status.
• Store additional information on why tasks are not yet finished.

Demo

Installation

1. Open Visual Studio Code.
2. Go to the Extensions tab.
3. Search for "Code Reporter" and click "Install".
4. Restart Visual Studio Code (if necessary).

Usage

1. Open a file in Visual Studio Code.
2. Select the code you want to include in the report.
3. Right-click and choose "Create Code Report" from the context menu.
4. Enter a description for the code.
5. The code report will be saved in the corresponding directory based on the current date.

Configuration

There is currently no configuration required for the extension.

Contributions

Contributions are welcome! If you want to contribute to this extension, please follow these steps:

1. Fork the repository.
2. Create a branch for your feature (git checkout -b feature/YourFeature).
3. Make your changes.
4. Commit and push your changes (git commit -am 'Add new feature' && git push origin feature/YourFeature).
5. Open a pull request to the main branch of the repository.

License

This extension is licensed under the MIT License. See LICENSE for more information.

Contact

For any inquiries or feedback, please feel free to contact me at [email protected].

Repository

The source code for this extension is available on GitHub: Code Reporter