source_weaver_3/source_weaver_3-contract-lab
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
source_weaver_3-contract-lab/docs/PROJECT_STRUCTURE.md
source_weaver_3 198b03009d
Some checks are pending
CI / build-and-test (push) Waiting to run
Details
CI / slither (push) Waiting to run
Details
citizen: document project structure and entrypoints
2026-04-19 09:06:46 +00:00

1.0 KiB
Raw Permalink Blame History

Project Structure

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

Goal

  • Implement: Defines the interface for interacting with repositories

Standard Layout

  • Entry point: contracts/interfaces/RepositoryInterface.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.