Humanizer .NET Library Development

Guidelines for developing and contributing to the Humanizer .NET library - a comprehensive solution for turning numbers, dates, times, enums, quantities, etc. into human-friendly text across many locales.

Project Structure

Development Environment Setup

Use the latest .NET SDK (see install script in `.github/copilot-instructions.md`):

```bash

dotnet --version

```

Coding Standards

General Guidelines

Code Style

```csharp

// Good

var result = someMethod();

string userName = "example";

// Avoid unnecessary this. and braces for one-line blocks

if (condition)

DoSomething();

```

Naming Conventions

Documentation

Testing Requirements

Test Structure

Culture-Specific Testing

```csharp

[UseCulture("en-US")]

[Fact]

public void SomeLocalizationTest()

{

// Test implementation

}

```

Running Tests

```bash

.NET 10.0

dotnet test src/Humanizer.Tests/Humanizer.Tests.csproj --framework net10.0

.NET 8.0

dotnet test src/Humanizer.Tests/Humanizer.Tests.csproj --framework net8.0

Note: Avoid net48 target on Linux

```

Build Process

Standard Build

```bash

From src directory

dotnet build Humanizer/Humanizer.csproj -c Release /t:PackNuSpecs /p:PackageOutputPath=<path>

```

Package Verification

```bash

After building packages

./verify-packages.ps1

Override minimum SDK version if needed

./verify-packages.ps1 -MinimumPassingSdkVersion "9.0.100"

```

NuGet Configuration

Localization Development

Adding New Locales

1. **Resource Files**

- Duplicate relevant resource files under `src/Humanizer/Properties`

- Translate content appropriately

2. **Register Formatters**

- Add to `Configuration/FormatterRegistry.cs`

- Update number converter factories

3. **Testing**

- Create tests under `src/Humanizer.Tests/Localisation/{culture}`

- Use `UseCulture` attribute for culture-specific tests

Quality Requirements

Code Quality

Test Coverage

Documentation Updates

When to Update

What to Update

Pull Request Guidelines

Preparation

Testing Checklist

Compatibility

Common Workflows

Adding a New Feature

1. Implement feature in `src/Humanizer`

2. Add comprehensive tests in `src/Humanizer.Tests`

3. Update XML documentation

4. Test across all target frameworks

5. Update readme if user-facing

Localization Workflow

1. Add resource files for new culture

2. Implement culture-specific formatters

3. Register in appropriate registries

4. Create targeted tests

5. Verify with culture-specific test runs

Package Development

1. Build with release configuration

2. Verify packages with verification script

3. Test package references in isolated environment

4. Ensure no NuGet.config changes are committed