Skip to content

Faithlife/CodingGuidelines

Repository files navigation

Faithlife Coding Guidelines

Sections

Conventions

Apply these guidelines and conventions automatically with Agentic Repository System.

Convention Description
agentic-repo Applies conventions useful for repositories that keep agent customization files in source control.
apm Installs configured packages for the Copilot APM target with apm and optionally updates existing packages.
build-script Installs the published build.ps1 script at the repository root.
config-text-section Manages one named text section in a repository file.
copilot-lsp Manages project-scoped GitHub Copilot CLI LSP server definitions in .github/lsp.json.
copilot-lsp-csharp Applies the published C# GitHub Copilot CLI LSP server configuration.
copilot-lsp-typescript This convention applies the published TypeScript GitHub Copilot CLI LSP server configuration.
dotnet-common Applies conventions common to repositories that build a .NET solution.
dotnet-sdk Ensures the repository has a global.json that uses the specified .NET SDK major version or later.
dotnet-sdk-10 Ensures the repository has a global.json that uses the .NET 10 SDK or later.
dotnet-slnx Ensures the repository uses .slnx solutions rather than .sln.
editorconfig-csharp Ensures the repository-root .editorconfig contains the standard C# section from files/.editorconfig.
editorconfig-json Ensures the repository-root .editorconfig contains the managed JSON section from files/.editorconfig.
editorconfig-md Ensures the repository-root .editorconfig contains the managed Markdown section from files/.editorconfig.
editorconfig-ps1 Ensures the repository-root .editorconfig contains the managed PowerShell section from files/.editorconfig.
editorconfig-root Ensures the repository-root .editorconfig contains the standard [*] section described in sections/editorconfig.md.
editorconfig-section Manages a named section within the repository-root .editorconfig file.
editorconfig-yaml Ensures the repository-root .editorconfig contains the managed YAML section from files/.editorconfig.
faithlife-auto-apply-conventions Ensures that .github/conventions.yml starts with the marker used by RepoConventionsApplier.
faithlife-dotnet-library-build Creates or refreshes Faithlife .NET library build project files under tools/Build.
faithlife-dotnet-library-workflow Installs the published Faithlife .NET library workflows at .github/workflows/ci.yml and .github/workflows/copilot-setup-steps.yml.
faithlife-license-mit Applies license-mit with copyright-holder set to Faithlife.
gitattributes-csharp Ensures the repository-root .gitattributes contains the standard C# section from files/.gitattributes.
gitattributes-lf Ensures the repository-root .gitattributes starts with * text=auto eol=lf.
gitattributes-section Manages a named section within the repository-root .gitattributes file.
gitignore-section Manages a named section within the repository-root .gitignore file.
license-mit Ensures the repository-root LICENSE file contains the published MIT license from files/LICENSE.
nuget-config Creates or replaces the repository-root nuget.config from files/nuget.config.
prettierignore-section Manages a named section within the repository-root .prettierignore file when the repository appears to use Prettier.

About

Faithlife's coding guidelines.

Topics

Resources

License

Stars

Watchers

Forks

Contributors