Method Signature Change Risk

Why this rule exists

Public method signatures are contracts. Removing a parameter, adding a required one, or changing the return type breaks every caller. These changes demand deprecation cycles, not silent breaking changes.

Code example

- public Task<User> GetUser(int id) { }
+ public Task<User> GetUser(Guid id) { }
+ // OR
- public void ProcessOrder(Order order) { }
+ public void ProcessOrder(Order order, ProcessOptions options) { }  // no default

  [Obsolete("Use GetUserAsync(Guid)")]
  public Task<User> GetUser(int id) => GetUserAsync(new Guid(id.ToString()));
+ public Task<User> GetUserAsync(Guid id) { }
+ // OR
+ public void ProcessOrder(Order order, ProcessOptions options = null) { }  // default provided

Configuration

Disable or adjust the severity of this rule in .gauntletci.json:

{
  "rules": {
    "GCI0055": { "enabled": true, "severity": "Info" }
  }
}

See Configuration for the full schema.

Related rules

Real-world evidence