Skip to content

Plugin for the Atom editor to be used with the Git Time Metric platform.

License

Notifications You must be signed in to change notification settings

git-time-metric/gtm-atom-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GTM Logo

Git Time Metric

Atom Git Time Metrics (GTM) Plugin

Simple, seamless, lightweight time tracking for all your git projects

Git Time Metrics (GTM) is a tool to automatically track time spent reading and working on code that you store in a Git repository. By installing GTM and using supported plug-ins for your favorite editors, you can immediately realize better insight into how you are spending your time and on what files.

This plugin will help to feed data for the projects that you work on in the Atom editor.

Installation

Installing GTM is a two step process. First, it's recommended you install the GTM executable that the plug-in integrates with and then install the Sublime 3 GTM plug-in. Please submit an issue if you have any problems and/or questions.

  1. Follow the Getting Started section to install the GTM executable for your operating system.
  2. Install the plug-in via Atom Community Packages.

Note - to enable time tracking for a Git repository, you need to initialize it with gtm init otherwise it will be ignored by GTM. This is done via the command line.

> cd /path/to/your/project
> gtm init

Configuration

  • Use GTM - Set this to TRUE if you have GTM installed and want to track metrics locally.
  • Location of GTM executable - Set this to the path where the gtm executable is installed. We attempt to detect this, but if it cannot be found, or if you just want to change it, do so here.

Features

Status Bar

In the status bar see your total time spent for in-process work (uncommitted).

Note - the time shown is based on the file's path and the Git repository it belongs to. You can have several files open that belong to different Git repositories. The status bar will display the time for the current file's Git repository. Also keep in mind, a Git repository must be initialized for time tracking in order to track time.

Command Line Interface

Use the command line to report on time logged for your commits.

Here are some examples of insights GTM can provide you.

GTM is automatic, seamless and lightweight. There is no need to remember to start and stop timers. It runs on occasion to capture activity triggered by your editor. The time metrics are stored locally with the git repository as Git notes and can be pushed to the remote repository.

Support

To report a bug, please submit an issue on the GitHub Page

Consult the README and Wiki for more information.

About

Plugin for the Atom editor to be used with the Git Time Metric platform.

Resources

License

Stars

Watchers

Forks

Packages

No packages published