One reviewer rule
Your repo should answer three questions fast: what does it do, how do I run it, and what risks did you think about.
A recruiter or mentor may open it between meetings. Make the first screen useful.
What to include
A credible Solidity repo is not only a contract file. It shows structure, proof, and judgement.
For this track, your public repo needs a Solidity 0.8.x contract, tests, deployment instructions, and a short security notes section. It should also show local test results and a testnet deployment address or a deployment script.
Repo checklist
Do each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 5 done
README skeleton
Use this as a minimum. Replace every placeholder before submission.
Do not paste private keys, seed phrases, RPC secrets, or paid API keys.
# Project name
Short description: what the contract does and who can call the main functions.
## Contract
- Solidity: 0.8.x
- Main contract: contracts/YourContract.sol
- Access control: owner-only functions listed here
## Run locally
1. Install dependencies
2. Run tests
3. Check the test output below
## Test result
Paste a short terminal output or screenshot link here.
Example: all tests passing locally on your machine.
## Deploy
Deployment script/module: path/to/deploy/file
Testnet address: 0x...
Network: testnet name
## Security notes
- Authorization uses msg.sender-based checks, not tx.origin.
- External calls are placed after state updates where relevant.
- No unbounded loop is required for normal user actions.
- Compiler warnings were checked before submission.
## Known limits
Write what your contract does not handle yet.Common submission mistakes
Do not submit only a contract file. That looks like a class assignment, not a shipped project.
Do not hide the weak parts. A short known limits section is better than pretending the contract is production-ready.
Use AI carefully
You can ask ChatGPT, Gemini, or Claude to review your README and security notes. Give it your contract summary, not secrets.
Check the output yourself. AI often makes confident claims like audit-ready, fully secure, or gas-optimized without proof. Remove those claims.
Final review flow
Do each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 5 done
Do this now
Do each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 5 done