Skip to content

Conversation

@AdekunleBamz
Copy link

Description

Enhanced the PR template with comprehensive sections tailored for Solidity smart contract development.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Performance improvement
  • Code refactoring

Changes Made

PR Template Enhancement

  • Added Type of Change section with categories (bug fix, feature, breaking change, docs, performance, refactoring)
  • Added Testing checklist with smart contract specific items:
    • Gas optimization verification
    • Slither static analysis passed
    • Forge fmt applied
  • Added comprehensive checklist for code quality and security:
    • Event emissions verified
    • Code style guidelines
    • Comment requirements
  • Added Related Issues section for better issue tracking

Testing

  • Unit tests pass
  • Integration tests pass
  • Manual testing completed
  • Gas optimization verified (for smart contract changes)
  • Slither static analysis passed
  • Forge fmt applied

Checklist

  • Code follows the project's style guidelines
  • Self-review of code completed
  • Code is commented, particularly in hard-to-understand areas
  • Corresponding changes to documentation made
  • No new warnings introduced
  • Tests added that prove the fix is effective or feature works
  • New and existing unit tests pass locally
  • Event emissions verified

Additional Notes

  • Template follows Solidity smart contract development best practices
  • Includes security-focused items (Slither, gas optimization)
  • Compatible with Foundry/Forge workflow

Related Issues

Link to related issues (e.g., Fixes #123)

SmartFlow Developer and others added 2 commits January 7, 2026 23:55
- Add Type of Change section with categories (bug fix, feature, breaking change, docs, performance, refactoring)
- Add Testing checklist with smart contract specific items (gas optimization, Slither, forge fmt)
- Add comprehensive checklist for code quality and security
- Add Related Issues section for better issue tracking
@AdekunleBamz AdekunleBamz closed this by deleting the head repository Jan 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants