Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (18 loc) · 924 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (18 loc) · 924 Bytes
Raw

Contributing

Guidelines

  • Do not commit media files, transcripts, generated reports, model weights, local cache folders, or personal paths.
  • Keep examples generic and path-agnostic.
  • Prefer clear configuration options over hard-coded local assumptions.
  • Update documentation when a user-facing command, config key, or workflow changes.
  • Preserve original media by default; destructive or replacement workflows must be explicit.

Validation

Before opening a pull request, run:

dotnet build .\src\LocalProfanityCensor.DotNet\LocalProfanityCensor.DotNet.csproj
dotnet run --project .\src\LocalProfanityCensor.DotNet -- validate-dictionary .\src\LocalProfanityCensor.DotNet\Dictionaries\profanity.example.yml

If your change touches deployment scripts, also run:

pwsh .\Deployment\Scripts\Publish-Core.ps1
pwsh .\Deployment\Scripts\Stage-Payload.ps1