/dotnet-authors

A tool for the project author list and copyright statements bookkeeping.

Primary LanguageF#MIT LicenseMIT

dotnet-authors Status Zero NuGet package

Supporting an open-source project means fulfilling some tasks that are not always pleasant.

One of the less pleasant tasks is maintaining accurate copyright statements and contributor lists across project files. As projects grow, manually updating copyright years and tracking all contributors becomes time-consuming and error-prone. This tool aims to automate these maintenance tasks by helping project maintainers keep copyright statements up-to-date and maintain accurate lists of project contributors.

It will allow to perform hassle-free, asynchronous updates of all the related metadata, and send pull-requests when something requires changes.

Installation

Install as a dotnet tool: either

$ dotnet tool install --global FVNever.DotNetAuthors

for global installation or

$ dotnet new tool-manifest
$ dotnet tool install FVNever.DotNetAuthors

for local solution-wide installation.

Usage

After installation, the tool will be available in shell as dotnet authors.

Always run the program from the repository root.

Usage:

  • --version - print the program version.
  • --help - print this message.
  • authors [file] - print authors contributed to a file (or all files in repo by default).
  • commits [file] - print commits contributed to a file (or all files in repo by default).

Versioning Policy

This project's versioning follows the Semantic Versioning 2.0.0 specification.

When considering compatible changes, we currently consider the project's public API is the command-line interface:

  • the way of running the project (e.g., the executable file name),
  • the input arguments,
  • the input data formats,
  • the output data format,
  • the program exit code.

Documentation

License

The project is distributed under the terms of the MIT license.

The license indication in the project's sources is compliant with the REUSE specification v3.3.