docs: add unsafe code guidelines to CONTRIBUTING.md#5363
Closed
PranavAgarkar07 wants to merge 1 commit into
Closed
docs: add unsafe code guidelines to CONTRIBUTING.md#5363PranavAgarkar07 wants to merge 1 commit into
PranavAgarkar07 wants to merge 1 commit into
Conversation
github-actions
Bot
added
the
Waiting On Review
github-actions
Bot
added
C-Documentation
Added a comprehensive Unsafe Code Guidelines section covering safety comment requirements, lint enforcement, type-punning conventions, the _unchecked suffix pattern, and MIRI testing requirements. Based on documented unsafe patterns in boa_gc, boa_engine, and boa_string. Includes concrete examples from the codebase for every pattern.
github-actions
Bot
removed
the
Waiting On Review
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses issue #4188 — adding comprehensive unsafe code guidelines to
CONTRIBUTING.md.Changes
Added an Unsafe Code Guidelines section to
CONTRIBUTING.mdcovering:unsafe fndeclarations with# Safetysectionsunsafe { }blocks with// SAFETY:commentsunsafe impl Traitcontract documentationunsafe_op_in_unsafe_fn,undocumented_unsafe_blocks,missing_safety_doc#[repr(C)]for type-punning,_uncheckedsuffix conventionAll examples are taken from actual Boa source code (
boa_gc,boa_engine,boa_string) rather than fabricated snippets.Related issue
Closes #4188