SwiftCommit⚡

A VS Code extension that automatically generates commit messages using NLP.

🔍Preview

SwiftCommit analyzes staged changes in your Git repository and generates a concise, context-aware commit message within the VS Code source control pane.

🚀Getting started

🔧 Prerequisites

Before using SwiftCommit, ensure you have the following installed on your system:

• 🐍 Python 3.8+ – Required for running the commit message generation model
• 🌱 Git – For version control and diff extraction
• 🖥️ Visual Studio Code – With the SwiftCommit extension installed

🛠 To check if Python is installed, run the following command in your terminal or command prompt:

python --version

If you see an error or an older version, download and install Python from python.org.

How to install and run the extension in VS Code.

1️⃣ Open Visual Studio Code.

2️⃣ Go to Extensions (Ctrl+Shift+X).

3️⃣ Search for SwiftCommit.

4️⃣ Click Install.

5️⃣ Restart VS Code if necessary.

⚠️ Important: Wait for Dependencies to Install!

After installing SwiftCommit, please wait for the Python dependencies to install completely before using the extension.

📌 SwiftCommit automatically installs transformers and torch when activated for the first time.

• ⏳ This process may take a few minutes, depending on your internet speed.
• 🔍 If you experience issues, check the VS Code output console for installation logs.
• 🛠️ You can also manually install dependencies by running:

python -m pip install transformers torch

✅ Once the installation is complete, you can start generating commit messages! 🚀

✨Features

• 🤖 Automated Commit Messages: Generates meaningful commit messages based on code changes.
• 📂 Supports Multiple File Types: Recognizes various programming languages and file extensions.
• 📌 Conventional Commits: Applies prefixes like feat, fix, chore, docs, and more.
• ⚡ One-Click Generation: Just press a button—no manual input required.
• 🧠 Optimized NLP Model: Uses a fine-tuned CodeT5 model for accurate commit summaries.
• 🚀 Fast & Efficient: Works seamlessly within your Git workflow.

⚖️Comparison with other extensions

🔄 Unlike Traditional Extensions

• Other extensions often require an API key because they use:
• 🤖 OpenAI's GPT (which requires a paid API key)
• ☁️ Hugging Face’s hosted models (which may need a free/paid key)
• 🖥️ Custom server-based AI models

• SwiftCommit is different because:
• 💻 Runs locally after setup Internet is needed only for the initial download.
• 🔐 No API keys or account setup needed.
• ⚡ Faster processing since everything happens on the user’s machine.

This makes SwiftCommit faster, more private, and easier to use. 🚀

🤖Powered by AI

SwiftCommit leverages CodeT5, a transformer-based NLP model trained specifically for code-related tasks. It analyzes diffs and generates commit messages that align with best practices and human-written summaries.

📜 License

SwiftCommit is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

SwiftCommit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with SwiftCommit. If not, see https://www.gnu.org/licenses/.

Credits

Developed by:

• 🧑‍💻 Gene Alprince M. Braga
• 👩‍💻 Antonette S. Manolis
• 👨‍💻 Mohammad Sali S. Jauhari

Adviser:

🎓 Special thanks to the Western Mindanao State University College of Computing Studies for supporting this research project.