Skip to content

Commit c433b91

Browse files
Change README wording to match new style challenge styles (#60)
2 parents 6502989 + 4ca3d09 commit c433b91

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

.changeset/mean-bees-divide.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"eth-tech-tree": patch
3+
---
4+
5+
Readme adjustments, Challenge formats revised

src/actions/setup-challenge.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@ const README_CONTENT = {
160160
- [Requirements](#requirements)
161161
- [Start Here](#start-here)
162162
- [Challenge Description](#challenge-description)
163+
- [Testing Your Progress](#testing-your-progress)
163164
- [Solved! (Final Steps)](#solved-final-steps)
164165
165166
## Requirements
@@ -178,9 +179,10 @@ Run the following commands in your terminal:
178179
yarn install
179180
foundryup
180181
\`\`\``,
181-
BOTTOM_CONTENT: `**Don't change any existing method names** as it will break tests but feel free to add additional methods if it helps you complete the task.
182+
BOTTOM_CONTENT: `## Testing Your Progress
183+
Use your skills to build out the above requirements in whatever way you choose. You are encouraged to run tests periodically to visualize your progress.
182184
183-
Start by using \`yarn foundry:test\` to run a set of tests against the contract code. You will see several failing tests. As you add functionality to the contract, periodically run the tests so you can see your progress and address blind spots. If you struggle to understand why some are returning errors then you might find it useful to run the command with the extra logging verbosity flag \`-vvvv\` (\`yarn foundry:test -vvvv\`) as this will show you very detailed information about where tests are failing. Learn how to read the traces [here](https://book.getfoundry.sh/forge/traces). You can also use the \`--match-test "TestName"\` flag to only run a single test. Of course you can chain both to include a higher verbosity and only run a specific test by including both flags \`yarn foundry:test -vvvv --match-test "TestName"\`. You will also see we have included an import of \`console2.sol\` which allows you to use \`console.log()\` type functionality inside your contracts to know what a value is at a specific time of execution. You can read more about how to use that at [FoundryBook](https://book.getfoundry.sh/reference/forge-std/console-log).
185+
Run tests using \`yarn foundry:test\` to run a set of tests against the contract code. Initially you will see build errors but as you complete the requirements you will start to pass tests. If you struggle to understand why some tests are returning errors then you might find it useful to run the command with the extra logging verbosity flag \`-vvvv\` (\`yarn foundry:test -vvvv\`) as this will show you very detailed information about where tests are failing. Learn how to read the traces [here](https://book.getfoundry.sh/forge/traces). You can also use the \`--match-test "TestName"\` flag to only run a single test. Of course you can chain both to include a higher verbosity and only run a specific test by including both flags \`yarn foundry:test -vvvv --match-test "TestName"\`. You will also see we have included an import of \`console2.sol\` which allows you to use \`console.log()\` type functionality inside your contracts to know what a value is at a specific time of execution. You can read more about how to use that at [FoundryBook](https://book.getfoundry.sh/reference/forge-std/console-log).
184186
185187
For a more "hands on" approach you can try testing your contract with the provided front end interface by running the following:
186188
\`\`\`bash

0 commit comments

Comments
 (0)