This page contains link to the development guidelines and more.
- General Guidelines
- Writing idiomatic, effective, and clean Go code
- Testing Guide: How to run the unit, fuzz, integration and Fabric-X tests.
- Debugging Integration Tests: Runbook for diagnosing failing integration tests (log locations, Docker and network inspection, Ginkgo focus and skip).
- Best Practices for Versioning Go Projects
- Development Tools
- Linting
- Monitoring
- Metrics Reference
- Grafana dashboards
- Storage: Store and StoreService layers, the SQL schema, and how the SQLite and Postgres backends differ.
- SQL Query DSL: The query builder used by the SQL stores, including bound parameters and pagination.
- Mock Files Generation
- AI Agents Best Practices
- Update fabric-smart-client: Runbook for bumping the
fabric-smart-clientdependency to the latestmain. - Tools: tokengen
- Tools: tokendiag
- Makefile Guide
- Documentation Guide: How to preview and build this documentation site with MkDocs (
make docs-serve,make docs-build).
- How to use SDK's: Current structure and guidelines for development of Panurus's SDKs.
- Common problems: Common problems you may encounter. You can document more issues to help onboarding of future developers.