Skip to content

Commit

Permalink
Clarify what alias to use
Browse files Browse the repository at this point in the history
  • Loading branch information
MihaZupan committed May 7, 2024
1 parent 1653578 commit 10d46a6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/libraries/Fuzzing/DotnetFuzzing/IFuzzer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ internal interface IFuzzer
/// <summary>Friendly name to identify this fuzz target in OneFuzz configuration.</summary>
string Name => GetType().Name;

/// <summary>Alias to assign crash report work items to.</summary>
/// <summary>Alias to assign crash report work items to.
/// The is a Microsoft alias, not your GitHub username.</summary>
string BlameAlias { get; }

/// <summary>List of assemblies that should be instrumented.
Expand Down
2 changes: 2 additions & 0 deletions src/libraries/Fuzzing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ internal sealed class IPAddressFuzzer : IFuzzer
```

- `BlameAlias` specifies who should be assigned work items if automated fuzzing discovers a bug.
- Note that these work items are filed in a Microsoft-internal system, so this must be a Microsoft alias.
- If you don't have one, feel free to pick a "victim" from the relevant area owners.
- `TargetAssemblies` is a list of assemblies where the tested code lives and that must be instrumented.
- `TargetCoreLibPrefixes` is the same, but for types/namespaces in `System.Private.CoreLib`.
- `FuzzTarget` is the logic that the fuzzer will run for every test input. It should exercise code from the target assemblies.
Expand Down

0 comments on commit 10d46a6

Please sign in to comment.