Skip to content

AGENTS.md

Latest commit

 

History

History
169 lines (115 loc) · 4.9 KB

AGENTS.md

File metadata and controls

169 lines (115 loc) · 4.9 KB
Raw

Orc.FeatureToggles

Orc.FeatureToggles is a WPF component that helps you manage feature toggles. It provides a complete set of functionality for defining, persisting, and toggling named features in Line of Business applications.

Orc.FeatureToggles consists of the following sub-projects:

  • Orc.FeatureToggles => Core library with feature toggle models, services, and providers.
  • Orc.FeatureToggles.Xaml => WPF library containing views and view models for managing feature toggles.

Critical Rules (Read First)

These rules are non-negotiable. Violating them causes broken builds, crashes, or downstream breakage.

1. Never Edit Generated Files

Files matching *.generated.cs, *.generated.xaml are auto-generated.

  • NEVER manually edit these files

2. ABI / API Stability

This project maintains stable ABI / API. Breaking changes break downstream apps.

Allowed Never
Add new overloads Modify existing signatures
Add new methods Remove public APIs
Add new classes Change return types

3. Tests Are Mandatory

Building alone is NOT sufficient. Run tests before claiming completion (see Commands).

4. Branch Protection (COMPLIANCE REQUIRED)

Direct commits to protected branches are a policy violation.

Repository Protected Branches
Orc.FeatureToggles master
Orc.FeatureToggles develop

Required workflow:

  1. Create a feature branch FIRST — Use naming convention: feature/issue-NNNN-description
  2. Make all commits on the feature branch — Never commit directly to protected branches
  3. Submit a Pull Request — Changes must be reviewed by a human before merging
# CORRECT — Always create a feature branch first
git checkout -b feature/issue-1234-fix-description

# NEVER DO THIS — Policy violation
git checkout develop && git commit  # FORBIDDEN

# NEVER DO THIS — Policy violation
git checkout master && git commit  # FORBIDDEN

The repository has protected branches that must be respected.

Commands

Single source of truth for all commands:

Task Command
Build dotnet cake --target=build
Test dotnet cake --target=test
Build and test dotnet cake --target=buildandtest

Architecture & Directories

Layer Overview

Orc.FeatureToggles => Cross-platform core: models, services, providers, extensions

Orc.FeatureToggles.Xaml => WPF-specific views and view models

Directory Guide

Directory Editable? Notes
*.generated.cs No Leave as-is
*.generated.xaml No Leave as-is
deployment/ No Deployment / build scripts
src/Orc.FeatureToggles/Models/ Yes Core data models (FeatureToggle, FeatureToggleValue)
src/Orc.FeatureToggles/Services/ Yes Core services (FeatureToggleService, FeatureToggleSerializationService, FeatureToggleInitializationService)
src/Orc.FeatureToggles/Providers/ Yes Toggle value providers
src/Orc.FeatureToggles/Extensions/ Yes Extension methods
src/Orc.FeatureToggles.Xaml/ Yes WPF views and view models
src/Orc.FeatureToggles.Tests/ Yes Test project
src/Orc.FeatureToggles.Example/ Yes Example application

Writing Code

Anti-Patterns (Never Do This)

Anti-Pattern Why
Modifying method signatures ABI breaking
Manual edits to *.generated.cs, *.generated.xaml Overwritten on regenerate
Using default parameters in public APIs ABI breaking
Skipping failing tests Unacceptable — tests must pass

Testing & Debugging

Running Tests

dotnet cake --target=test

Tests MUST Pass

NON-NEGOTIABLE: Tests must PASS before claiming completion.

  • Do NOT skip failing tests
  • Do NOT claim completion if tests fail
  • Do NOT use SkipException to work around failures

Writing Tests

  1. Use NUnit to write tests
  2. Create a Facts class for a feature
  3. Combine Pascal / Snake case for test methods (e.g. Feature_Does_Work)
[TestCase]
public void Feature_Does_Work()
{
    var result = 47 - 5;

    Assert.That(result, Is.EqualTo(42));
}

Philosophy: Tests FAIL when wrong, never skip (except missing hardware).

Debugging Methodology

  1. Establish baseline — What's the known-good state?
  2. One change at a time — Verify each change before proceeding
  3. Track changes in a table — Log what you changed and the result
  4. Platform differences are signals — If X works and Y fails, the difference IS the answer
  5. Revert if worse — Don't pile fixes on top of failures

Further Reading

Topic Document
Contributing CONTRIBUTING.md
Documentation opensource.wildgums.com