Developer Documentation¶
This documentation is aimed at execution-spec-tests
developers:
- Managing configurations: Instructions for setting up and modifying test configurations.
- Interactive usage: Guide on interactive use of EEST packages using
ipython
. - Documenting CLI commands: Instructions for documenting command line interfaces (CLIs).
- Coding style: Standards and best practices for code formatting and to maintain consistency across the repository.
- Logging: Documentation on using the custom logging system with enhanced features.
- Enabling pre-commit checks: A guide for setting up pre-commit hooks to enforce code quality before commits.
- Running github actions locally: Instructions for testing GitHub Actions workflows on your local machine to streamline development and debugging.
- Porting tests: A guide to porting legacy ethereum tests to EEST.
These sections are primarily aimed at execution-spec-tests
maintainers:
- Generating documentation: Steps to create and build documentation and manage documentation versions.
- Managing dependencies and packaging: How to update EEST dependencies.