Skip to content

docs(ai): update#359

Merged
KSXGitHub merged 1 commit into
remove-some-parts-of-contribution-guidefrom
claude/remove-contributing-sections-I0FJ1
Mar 18, 2026
Merged

docs(ai): update#359
KSXGitHub merged 1 commit into
remove-some-parts-of-contribution-guidefrom
claude/remove-contributing-sections-I0FJ1

Conversation

@KSXGitHub

Copy link
Copy Markdown
Owner

Summary

Updates the coding guidelines across documentation files to relax two Rust code style requirements that are no longer enforced or desired.

Changes

  • Remove #[non_exhaustive] requirement for custom errors: Custom error types now only need #[derive(Debug, Display, Error)] without the #[non_exhaustive] attribute
  • Remove #![deny(warnings)] requirement: Code is no longer required to be completely warning-free, allowing for more flexibility during development

Details

These changes were applied consistently across three documentation files:

  • .github/copilot-instructions.md
  • AGENTS.md
  • CLAUDE.md

This aligns the documented guidelines with the actual project requirements and reduces unnecessary constraints on contributors and AI agents.

https://claude.ai/code/session_012rU7VAeZADzFWewCEUMMyG

Remove `#[non_exhaustive]` from custom errors bullet and remove
`#![deny(warnings)]` bullet, matching the removals in PR #358.

https://claude.ai/code/session_012rU7VAeZADzFWewCEUMMyG
@KSXGitHub KSXGitHub changed the title Update coding guidelines: remove non_exhaustive and deny(warnings) requirements docs(ai): update Mar 18, 2026
@KSXGitHub KSXGitHub marked this pull request as ready for review March 18, 2026 03:31
@KSXGitHub KSXGitHub merged commit 261e54a into remove-some-parts-of-contribution-guide Mar 18, 2026
12 of 13 checks passed
@KSXGitHub KSXGitHub deleted the claude/remove-contributing-sections-I0FJ1 branch March 18, 2026 03:32
@github-actions

Copy link
Copy Markdown

Performance Regression Reports

commit: e58ce0f

--quantity=block-count --max-depth=10 --min-ratio=0.01 --progress --no-sort
Command Mean [ms] Min [ms] Max [ms] Relative
pdu 119.8 ± 36.4 104.7 210.9 1.10 ± 0.39
pdu-0.20.0 108.6 ± 19.1 104.5 206.0 1.00
Logs
Benchmark 1: pdu
  Time (mean ± σ):     119.8 ms ±  36.4 ms    [User: 104.5 ms, System: 295.0 ms]
  Range (min … max):   104.7 ms … 210.9 ms    28 runs
 
  Warning: Statistical outliers were detected. Consider re-running this benchmark on a quiet system without any interferences from other programs. It might help to use the '--warmup' or '--prepare' options.
 
Benchmark 2: pdu-0.20.0
  Time (mean ± σ):     108.6 ms ±  19.1 ms    [User: 100.2 ms, System: 295.4 ms]
  Range (min … max):   104.5 ms … 206.0 ms    28 runs
 
  Warning: Statistical outliers were detected. Consider re-running this benchmark on a quiet system without any interferences from other programs. It might help to use the '--warmup' or '--prepare' options.
 
Summary
  pdu-0.20.0 ran
    1.10 ± 0.39 times faster than pdu
JSON
{
  "results": [
    {
      "command": "pdu",
      "mean": 0.11978994351142858,
      "stddev": 0.03640317110084562,
      "median": 0.10520265244,
      "user": 0.10451932142857144,
      "system": 0.29501095999999993,
      "min": 0.10468749244,
      "max": 0.21088831344000003,
      "times": [
        0.10477396344,
        0.10478172344,
        0.10508019144,
        0.10468749244,
        0.10503772844,
        0.10514137644,
        0.10485013544,
        0.10519694344,
        0.10509818844,
        0.10597501344,
        0.10493059844000001,
        0.10552162844,
        0.10578051044,
        0.10564209344,
        0.10508494444000001,
        0.10479033644,
        0.10557152244000001,
        0.10592641244,
        0.20612313844000002,
        0.21088831344000003,
        0.10548292844,
        0.10532209844,
        0.10474426844,
        0.10536015644,
        0.20625714544,
        0.20604117844000003,
        0.10520836144000001,
        0.10482002644
      ],
      "exit_codes": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    },
    {
      "command": "pdu-0.20.0",
      "mean": 0.10863559272571434,
      "stddev": 0.01907815124600683,
      "median": 0.10509386894,
      "user": 0.10019814285714287,
      "system": 0.29535713857142853,
      "min": 0.10452733944,
      "max": 0.20597186744,
      "times": [
        0.10515846844,
        0.10490816044000001,
        0.10536533444,
        0.10497476744,
        0.10520928044,
        0.10452733944,
        0.10533880844,
        0.10473378244,
        0.10460767944,
        0.10472745644,
        0.10516530144,
        0.10543732744,
        0.10525128144,
        0.20597186744,
        0.10499433344,
        0.10478860644,
        0.10522331144000001,
        0.10459393744,
        0.10469429844,
        0.10504693244,
        0.10470609044,
        0.10544622544,
        0.10533661044,
        0.10499932044,
        0.10535299144,
        0.10525741644,
        0.10514080544,
        0.10483886144
      ],
      "exit_codes": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ]
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants