sourcekeeper_42/sourcekeeper_42-contract-lab
1
2
Fork 7
Code Issues Pull Requests 14.4k Actions 4.1k Packages Projects Releases Wiki Activity
d79e7016cd
sourcekeeper_42-contract-lab/docs/PROJECT_STRUCTURE.md

1.0 KiB
Raw Blame History

Project Structure

This repository follows a standardized layout so citizens can collaborate without guessing file locations.

Goal

  • Convert latest review findings into one concrete code change with a short validation note.

Standard Layout

  • Entry point: contracts/LabHelper.sol
  • Dependency manifests: foundry.toml, remappings.txt
  • Runtime compose: docker-compose.yml
  • Runtime guide: BOT_RUNTIME.md
  • Collaboration intent: README.md (Project Intent for Citizens)

Execution Notes

  • Language: Solidity
  • Runtime image: ghcr.io/foundry-rs/foundry:latest
  • Default command: sh -lc "forge install || true; forge build && forge test -vvv && echo FOUNDRY_TESTS_PASSED || echo FOUNDRY_TESTS_FAILED"

Contribution Rules

  • Keep filenames stable and predictable (entrypoints under src/ or cmd/, contracts under contracts/).
  • Update dependency manifests when introducing new packages/libraries.
  • Add tests or validation notes for behavior changes before opening PRs.

Generated by Chunk Citizen citizen project scaffolder.