repo-conventions 1.1.0

RepoConventions

RepoConventions is a .NET tool that runs convention scripts configured for a repository, committing any resulting changes and optionally opening a GitHub pull request.

Quick Start

Before running RepoConventions, make sure the following tools are installed:

• dotnet: .NET 10 SDK or later
• pwsh: PowerShell 7 or later
• git: Git CLI, configured and authenticated
• gh: GitHub CLI, configured and authenticated (for opening PRs)

Individual conventions may require additional tools.

Run the tool with dnx:

dnx repo-conventions --help

Alternatively, e.g. to run in a repository configured for .NET 8, which doesn't suppport dnx, install the tool globally:

dotnet tool install -g repo-conventions
repo-conventions --help

To add a convention to the current repository:

dnx repo-conventions add Faithlife/CodingGuidelines/conventions/gitattributes-lf

That command creates .github/conventions.yml if it does not already exist:

conventions:
  - path: Faithlife/CodingGuidelines/conventions/gitattributes-lf

A configuration can also pass settings to a convention:

dnx repo-conventions add Faithlife/CodingGuidelines/conventions/write-file --with "{settings: {file: docs/example.md, overwrite: false}}"

The command writes the configured convention reference:

conventions:
  - path: Faithlife/CodingGuidelines/conventions/write-file
    settings:
      file: docs/example.md
      overwrite: false

Use repository-root-relative paths for conventions checked into the target repository:

conventions:
  - path: /.github/conventions/local-policy

Commit the configuration file, then apply the convention:

dnx repo-conventions apply

Features

• Repository Configuration — Configure .github/conventions.yml, declare local and remote conventions, pass settings, and configure pull request metadata.
• CLI Reference — Run the add, validate, and apply commands, with path options, pull request options, and clean-repository requirements.
• Convention Configuration — Learn the shared YAML model for convention references, settings, commit settings, and pull request settings.
• Convention Authoring — Create idempotent convention directories with convention.yml, scripts, local documentation, tests, and child settings expressions.