Skip to content

feat(ct): add INTERFACES.md#12359

Merged
smartcontracts merged 1 commit intodevelopfrom
sc/interfaces-doc
Oct 9, 2024
Merged

feat(ct): add INTERFACES.md#12359
smartcontracts merged 1 commit intodevelopfrom
sc/interfaces-doc

Conversation

@smartcontracts
Copy link
Copy Markdown
Contributor

Adds INTERFACES.md to explain how contract interfaces are used within the contracts-bedrock package.

@smartcontracts smartcontracts requested a review from a team as a code owner October 7, 2024 18:14
@smartcontracts smartcontracts requested a review from refcell October 7, 2024 18:14
Copy link
Copy Markdown
Contributor

@mds1 mds1 left a comment

Choose a reason for hiding this comment

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

This is really great, just two small comments

@semgrep-app
Copy link
Copy Markdown
Contributor

semgrep-app bot commented Oct 9, 2024

Semgrep found 4 sol-style-return-arg-fmt findings:

Named return arguments to functions must be appended with an underscore (_)

Ignore this finding from sol-style-return-arg-fmt.

Semgrep found 2 sol-style-malformed-revert findings:

  • packages/contracts-bedrock/scripts/deploy/DeployConfig.s.sol
  • packages/contracts-bedrock/scripts/deploy/Deploy.s.sol

Malformed revert statement style.

Ignore this finding from sol-style-malformed-revert.

Semgrep found 22 sol-style-input-arg-fmt findings:

Inputs to functions must be prepended with an underscore (_)

Ignore this finding from sol-style-input-arg-fmt.

Adds INTERFACES.md to explain how contract interfaces are used
within the contracts-bedrock package.
@smartcontracts smartcontracts added this pull request to the merge queue Oct 9, 2024
github-merge-queue bot pushed a commit that referenced this pull request Oct 9, 2024
Adds INTERFACES.md to explain how contract interfaces are used
within the contracts-bedrock package.
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 9, 2024
@smartcontracts smartcontracts added this pull request to the merge queue Oct 9, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 9, 2024
@smartcontracts smartcontracts added this pull request to the merge queue Oct 9, 2024
Merged via the queue into develop with commit 6d36d68 Oct 9, 2024
@smartcontracts smartcontracts deleted the sc/interfaces-doc branch October 9, 2024 22:20
samlaf pushed a commit to samlaf/optimism that referenced this pull request Nov 10, 2024
Adds INTERFACES.md to explain how contract interfaces are used
within the contracts-bedrock package.
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