Skip to content

ChimeMate is a GitHub productivity VS Code extension that helps developers stay on track by automatically logging their coding activity every 30 minutes, creating a detailed, time-based record of their work with every commit.

License

Notifications You must be signed in to change notification settings

Chen-Abudi/ChimeMate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

54 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

ChimeMate - GitHub Productivity VSCode Extension

🧠 Open source Project

Developed by Grace Chen Abudi πŸ‘©πŸ½β€πŸ’»


The Problem

Have you ever found yourself coding for hours, totally in the zone mode, and then realized you can't quite recall what you actually did? Between commits, context switching, debugging marathons, and jumping across files, it's easy to lose track of our progress especially when commits don't quite reflect the full picture. Manual journaling or remembering every change isn't realistic for busy developers.


The Solution - Meet ChimeMate

ChimeMate acts as your personal commit companion, quietly keeping a timeline of your coding journey. It automatically logs your progress every 30 minutes, summarizes changes, and syncs them with GitHub, so your work history stays clear, structured, and transparent without any extra effort.

Whether your'e freelancing, contributing to open source, or just learning, ChimeMate helps you see your growth unfold one commit at a time


Why You'll Love It

  • No more forgetting what you worked on.
  • No more messy commit history.
  • Just pure visibility into your daily progress, simple, smart, and seamless.

Core Features

  • Auto Commit Logging: Automatically logs code progress at regular intervals (default: every 30 minutes).

  • GitHub Commit Fetching: Integrates with the GitHub API to fetch detailed commit data: author, changed files, stats, additions, deletions, and more.

  • Local Commit History: Stores structured commit logs in JSON format for easy access and time tracking.

  • Error-Handled API Access: Gracefully handles API failures so your workflow never stops.

  • Console Feedback: Clear, friendly logs let you know when auto-logging or syncing is in progress.


🌱 ⏳ Coming Soon

Just got started, but here's what's next on ChimeMate's journey:

  • Visual Commit Timeline: A sleek sidebar panel inside VS Code to visualize your commit history at a glance.

  • Cloud Sync: Keep your logs backed up and accessible across all your devices.

  • AI-generated Commit Summaries: Smart, meaningful summaries generated automatically by LLMs.

  • Test Coverage Insights: Track testing performance alongside commits.

  • Multi-platform Git Provider Support: Optional support for GitLab, Bitbucket, and beyond.


βš™οΈ Requirements

  • Node.js β‰₯ 18.x
  • GitHub Personal Access Token (for GitHub integration)
  • VS Code version 1.70 or later

Important

Make sure your token is added securely via environment variables or the VSCode settings.

Important

Ensure your token has repo access to read commit metadata.


πŸ”§ Extension Settings

This extension contributes the following VS Code settings:

Setting Description
chimeMate.enable Enable/disable ChimeMate
chimeMate.autoLogInterval Set how often to auto-log commits (interval in minutes)
chimeMate.githubToken Add your GitHub token securely
chimeMate.repositoryUrl Define your GitHub repository URL (e.g., https://github.com/user/repo)

Installation

  1. Clone this repository and open it in VS Code.
  2. Run npm install to install dependencies.
  3. Press F5 to launch a development instance of VS Code with ChimeMate running.

🐞 Known Issues

  • Currently supports public GitHub repositories only.
  • Logging currently writes to local JSON only (no cloud sync yet).
  • Auto-log pauses if VSCode is idle or closed.

πŸ“ Release Notes

1.0.0

  • Initial release of ChimeMate.

1.1.0

  • GitHub API integration for commit metadata

  • Commit logs stored in commitLogs.json

  • Secure GitHub token handling via settings/environment

  • Refactored directory structure into src/github, src/types, and src/utils


βœ… Roadmap (Next Milestones)

  • πŸ“Š Add visual commit timeline panel inside VS Code
  • πŸ“ Edit commit comments pre-logging
  • 🌿 Support multi-branches and multi-repo
  • ☁️ Cloud-based commit log storage backup
  • πŸ“… Auto-generated weekly coding reports & visual insights
  • 🌐 Git provider support (GitLab/Bitbucket)

🀝🏽 Contributing

Contributions are always welcome from all developers skill levels! Whether you’re fixing bugs, improving docs, or dreaming up new features Please check out the CONTRIBUTING.md and browse the open issues to find a good place to start.


πŸ“œ Community & Policies

ChimeMate is built with aloha and respect 🌺.

I strive to create a collaborative and respectful community where everyone feels valued and safe. Please take a moment to read the guidelines and the security policy:


πŸ“š Additional Resources


Track your progress. Celebrate your growth. One commit at a time.

About

ChimeMate is a GitHub productivity VS Code extension that helps developers stay on track by automatically logging their coding activity every 30 minutes, creating a detailed, time-based record of their work with every commit.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors