Epitech Commit README

Overview

Epitech Commit is a Visual Studio Code extension designed to streamline and enhance the git commit process, ensuring that commits adhere to a standardized format. This extension facilitates quick and efficient commits while respecting the specified coding standards.

Features

Add Changes

Execute the commit tool by pressing F1 and selecting "Add Commit & Push Changes.". An error will be raised if there are no modified in your working directory.

Select Files To Add

Choose among all modified files to add, commit and push them on GitHub.

Commit Changes Command

Execute the commit tool by pressing F1 and selecting "Commit Changes.". An error will be raised if there are no modifications in your working directory.

Commit Types

Choose from 7 commit types:

• Feature
• Fix
• Coding Style
• Refactor
• Perf
• Test
• Documentation
• Chore

Functionality Addition/Removal

Depending on the selected commit type, the extension may prompt you to specify whether you are adding or removing functionality.

Summary Input

Provide a summary of all your changes when prompted. Detailed Commit Messages

The extension generates a detailed, complete, and compliant commit message following this norm:

• [Type] [Range] : Summary
• File created: Files
• File modified: Files
• File deleted: Files
• File renamed: File1 -> File2

Example :

[Chore] [+] : Importing library and Makefile
File created: myLib/helloWorld.c, Makefile
File modified: main.c

Usage

Press F1 to open the command palette. Select Commit Changes to initiate the commit process. Choose the appropriate commit type and respond to any additional prompts. Provide a summary of your changes. Enjoy a detailed and compliant commit message.

Installation

Open Visual Studio Code. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X on macOS). Search for Epitech Commit and click Install.

Feedback and Contributions

Feel free to provide feedback or contribute to the development of this extension on GitHub. License

This extension is licensed under the MIT License.

Happy Coding!