Add property documentation standards and standardize ERC20BasicProper… #66
Conversation
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
|
Omar Inuwa seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
…ties This PR addresses issue crytic#39 by establishing comprehensive documentation standards for all property test functions in the repository. Changes: - Add PROPERTY_STANDARDS.md defining complete documentation standards - NatSpec template with required tags (@title, @notice, @dev, @Custom) - 5 testing modes documented (INTERNAL/EXTERNAL/ISOLATED/FUNCTION_OVERRIDE/MODEL) - Property ID format: [STANDARD]-[CATEGORY]-[NUMBER] - Section organization guidelines matching ABDKMath64x64 style - Before/after examples and contribution checklist - Standardize ERC20BasicProperties.sol (17 properties) - Add comprehensive contract-level NatSpec documentation - Organize into 4 logical sections with standardized headers: * Supply Accounting (1 property) * Balance Accounting (3 properties) * Transfer Properties (10 properties) * Allowance Properties (3 properties) - Add full NatSpec to all 17 properties with: * Testing mode specification (INTERNAL) * Plain English invariant descriptions * Unique property IDs (ERC20-SUPPLY-001 through ERC20-ALLOWANCE-003) * Detailed explanations of why each property matters Standardizing ERC20BasicProperties is the first of many files that will be updated to follow these standards. This establishes the foundation and reference implementation for standardizing the remaining 151 properties across ERC20, ERC721, ERC4626, and Math library contracts. Fixes crytic#39
omarinuwa
force-pushed
the
standardize-erc20-basic-properties
branch
from
5585d6b to
289f932
Compare
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.
This PR addresses issue #39 by establishing comprehensive documentation standards for all property test functions in the repository.
Changes:
Add PROPERTY_STANDARDS.md defining complete documentation standards
Standardize ERC20BasicProperties.sol (17 properties)
Standardizing ERC20BasicProperties is the first of many files that will be updated to follow these standards.
Addresses #39