Skip to content

feat: add-testing-guide#99

Open
ashitakah wants to merge 1 commit intodevfrom
feat/testing-guide
Open

feat: add-testing-guide#99
ashitakah wants to merge 1 commit intodevfrom
feat/testing-guide

Conversation

@ashitakah
Copy link

CLOSES OPT-1225

@linear
Copy link

linear bot commented Oct 15, 2025

@vercel
Copy link

vercel bot commented Oct 15, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
aztec-handbook Ready Ready Preview Comment Oct 15, 2025 4:17pm
handbook Ready Ready Preview Comment Oct 15, 2025 4:17pm
op-handbook Ready Ready Preview Comment Oct 15, 2025 4:17pm


These guidelines complement the [Processes](../processes/overview.md) section, which covers workflows and phases of development. Here, we focus on the craft: what your code should look like, how to test it, and the habits that make you a stronger contributor.

## Guidelines Available
Copy link
Member

Choose a reason for hiding this comment

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

This might be quite repetitive. Instead of listing the available guidelines, just jump to the getting started section.


Testing is the first line of defense against bugs and exploits. In systems that handle real value and compose across chains, tests aren't optional, they're how we sleep at night.

This guide explains how we test code in the Optimism ecosystem: the structure and conventions you must follow, what kinds of tests to write, how to organize them, and best practices for writing maintainable test suites.
Copy link
Member

Choose a reason for hiding this comment

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

If you are going to list the things in the guide, just go straight there. The paragraph above feels repetitive.


These guidelines complement the [Processes](../processes/overview.md) section, which covers workflows and phases of development. Here, we focus on the craft: what your code should look like, how to test it, and the habits that make you a stronger contributor.

## Guidelines Available
Copy link
Member

Choose a reason for hiding this comment

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

Guidelines Available are repetitive. Let's only keep the getting started part.

Copy link
Member

Choose a reason for hiding this comment

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

In general, this file could be divided into different documents within a folder. It could be named 'Testing guidelines', the overview file should be the content until line 31. Then, you could divide the rest into different pages: Linting, file organization, Best practices.

@oxlumi
Copy link
Member

oxlumi commented Oct 16, 2025

Btw, please check the CI that is failling.

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants