https://github.com/rkotze/git-mob-vs-code
Co-author commits. A quick way to add co-author metadata to a Git commit via VS Code source control panel.
https://github.com/rkotze/git-mob-vs-code
co-author git git-emojis git-mob github hacktoberfest mob-programming pair-programming vscode vscode-extension workspace-support
Last synced: 3 months ago
JSON representation
Co-author commits. A quick way to add co-author metadata to a Git commit via VS Code source control panel.
- Host: GitHub
- URL: https://github.com/rkotze/git-mob-vs-code
- Owner: rkotze
- License: mit
- Created: 2018-12-21T16:31:00.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-10T09:56:44.000Z (11 months ago)
- Last Synced: 2025-02-10T10:39:34.981Z (11 months ago)
- Topics: co-author, git, git-emojis, git-mob, github, hacktoberfest, mob-programming, pair-programming, vscode, vscode-extension, workspace-support
- Language: JavaScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=RichardKotze.git-mob
- Size: 3.66 MB
- Stars: 38
- Watchers: 5
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 
Co-author commits
 [](https://open-vsx.org/extension/RichardKotze/git-mob)
> VS Code extension to easily _co-author a commit_ message from the source control panel.
Helpful when **pair programming**.
1. [Install](#install)
2. [Quick start](#quick-start)
3. [Features](#features)
4. [Notable changes](#notable-changes)
5. [Settings](#settings)
6. [Contributing](https://github.com/rkotze/git-mob-vs-code/blob/master/CONTRIBUTING.md)
## Install
Open VS Code and search for **"git-mob"** in **Extensions panel**.
OR
Via the terminal `code --install-extension RichardKotze.git-mob`
Available in [VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=RichardKotze.git-mob) and [open VSX registry](https://open-vsx.org/extension/RichardKotze/git-mob)
If you also use _[git-mob cli](https://github.com/rkotze/git-mob/#install)_ they work fine together.
## Quick start
### Key commands
**Select co-authors** - `CTRL+shift+p` or `⌘+⇧+p` -> "Select co-authors". Use the multi-selector to add and remove co-authors.
**Solo** - clear all selected co-authors: `CTRL+shift+p` or `⌘+⇧+p` -> "Solo: remove all co-authors"
Add new co-authors from [repository contributors](#search-repository-contributors-co-authors) or add directly to your co-authors file [`.git-coauthors`](#add-new-co-authors).
### Saving your co-authors
To keep track of co-authors git-mob uses a JSON file called `.git-coauthors`, and will try to find it in the following directories:
1. If `GITMOB_COAUTHORS_PATH` environment variable is set this will override any other settings.
1. If the current Git repository has a `.git-coauthors` file in the root directory.
1. The default is the users home directory at `~/.git-coauthors`.
## Features
- Append _multiple co-authors_ to a commit message
- Select multiple co-authors (`shift` or `ctrl` or `⌘`) in SCM panel view
- Easily add co-author data by [searching repository contributors co-authors](#search-repository-contributors-co-authors) from the "More Authors" list.
- **After a commit** [remove all selected co-authors](#post-commit---solo)
- [Workspace support](#workspace-support), multiple Git repositories
- **Search and add** co-authors from **GitHub** using anonymous email
- [Change primary author](#change-primary-author)
- Right-click and copy co-author data.
- Add [emojis](#git-emojis) to commits (Gitmojis)
- Configurable see [setting options](#settings)
### Notable changes:
1. [Global Git Mob](https://github.com/rkotze/git-mob-vs-code/discussions/120) meaning switch between projects will have same co-authors selected. (`v1.17.0`)
2. `prepare-commit-msg` hook support **removed** (`v1.12.0`)
### Add new co-authors
**Option 1:** `CTRL+shift+p` or `⌘+⇧+p` -> "Add new co-author". Fill in all input fields.
**Option 2:** `ctrl+shift+p` or `⌘+⇧+p` -> "Open .git-coauthors file" or use UI to open co-authors file `.git-coauthors`.
### Add from repository contributors
Click the **plus +** button on an author in **More Authors** list.
### Search repository contributors co-authors
Click the search icon on the **More Authors** section or `CTRL+shift+p` or `⌘+⇧+p` -> "Search Git repository for co-authors".
### Workspace support
Select one of multiple open Git repositories and add co-author metadata to source control input field. You can have different co-authors applied to all the open Git repositories.
### Git Emojis
Using the **standardised** list from [Gitmoji](https://github.com/carloscuesta/gitmoji).
Search and select an emoji to add to the Git message input field.
`CTRL+shift+p` or `⌘+⇧+p` -> "Search Gitmojis - emojis"
### Change primary author
`CTRL+shift+p` or `⌘+⇧+p` -> "Change primary author"
## Settings
### Post commit -> Solo
After a commit remove selected co-authors. If you commit in the command-line the UI will update as well.
`Default: false`
### Author list -> Expand more authors
Expand 'More Authors' tree when UI starts.
`Default: true`
### Author list -> More Authors To Co-authoring
Add a new author directly to 'Co-authoring' from 'More Authors'.
`Default: true`
### Co-authors -> Sort direction
Co-author list sorting direction.
`Default: ascending`