Skip to content

docs: clarify no_std support policy - #618

Open
sandersaares wants to merge 2 commits into
mainfrom
copilot/no-std-guidance
Open

docs: clarify no_std support policy#618
sandersaares wants to merge 2 commits into
mainfrom
copilot/no-std-guidance

Conversation

@sandersaares

@sandersaares sandersaares commented Jul 30, 2026

Copy link
Copy Markdown
Member

[Copilot speaking]

Summary

  • treats adoption or expansion of no_std support as optional when it would add disproportionate implementation complexity
  • defines every documented no_std configuration as a real compatibility promise rather than best-effort support
  • requires supported configurations to work correctly, be covered by CI, and document their prerequisites and target boundary

Validation

  • just spellcheck

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 6dd33204-34d1-4975-978f-fa8194190318
Copilot AI review requested due to automatic review settings July 30, 2026 11:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository’s contributor/agent guidance to clarify the intended policy around no_std support, setting expectations for implementation complexity and for aligning documentation/CI with what the crate actually promises.

Changes:

  • Adds a dedicated no_std support policy section to AGENTS guidance.
  • Clarifies that no_std is best-effort and should not drive complex cfg branching or specialized fallbacks for constrained targets.
  • Requires public docs and CI coverage to match explicitly supported configurations/prerequisites.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov

codecov Bot commented Jul 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.0%. Comparing base (c1df038) to head (765b879).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #618   +/-   ##
=======================================
  Coverage   100.0%   100.0%           
=======================================
  Files         470      470           
  Lines       45251    45251           
=======================================
  Hits        45251    45251           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 6dd33204-34d1-4975-978f-fa8194190318
Copilot AI review requested due to automatic review settings July 30, 2026 11:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@Vaiz

Vaiz commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

this clarification is only for agents. what about developers? do they also have to follow it?

@sandersaares

Copy link
Copy Markdown
Member Author

this clarification is only for agents. what about developers? do they also have to follow it?

The way I see it, we are in a world where the agents are the developers.

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.

4 participants