An open API service indexing awesome lists of open source software.

https://github.com/lorenzck/github-coauth-tool

Simple .NET global tool to generate GitHub co-authorship commit lines.
https://github.com/lorenzck/github-coauth-tool

dotnet dotnet-core dotnet-global-tool dotnet-global-tools github

Last synced: 3 months ago
JSON representation

Simple .NET global tool to generate GitHub co-authorship commit lines.

Awesome Lists containing this project

README

        

![Logo](https://raw.githubusercontent.com/LorenzCK/github-coauth-tool/master/graphics/gitcoauth-logo-128.png)

# GitCoAuth

![Badge](https://img.shields.io/nuget/v/dotnet-gitcoauth.svg)

GitCoAuth is a **simple .NET Core Global Tool** that will help you generate **co-authorship commit lines**, as you should.

## Usage

After installing, run it passing your co-author's *GitHub username* as a parameter.
For instance:

```
gitcoauth lorenzck
```

will output the following line (and it will also automatically try to copy it to your clipboard):

```
Co-authored-by: Lorenz Cuno Klopfenstein
```

Append the line to your commit message [following this GitHub guide](https://github.blog/2018-01-29-commit-together-with-co-authors/) (that is leaving at least one empty line between the commit message and the co-authorship trailer).
Once committed and pushed to GitHub, you and your co-authors will all have ownership of the commit. ✌

## Installation

Run the following command from shell:

```
dotnet tool install -g dotnet-gitcoauth
```

To uninstall the tool again:

```
dotnet tool uninstall -g dotnet-gitcoauth
```