Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
111 lines (80 loc) · 2.87 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

111 lines (80 loc) · 2.87 KB
Raw

Description

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • 🧪 Test addition or improvement
  • 🔧 Refactoring (no functional changes)
  • 🎨 Style/formatting changes
  • ⚡ Performance improvement

Related Issues

Fixes # Related to #

Changes Made

Testing Performed

Manual Testing

  • Tested locally with clarinet check
  • Tested in clarinet console
  • Tested specific edge cases

Automated Testing

  • All existing tests pass
  • Added new tests for changes
  • Tests cover edge cases

Test Commands Run

# List the commands you ran to test
clarinet check
clarinet console3

Test Results

# Paste test output here

Checklist

Code Quality

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Documentation

  • I have updated the documentation accordingly
  • I have updated the README.md (if needed)
  • I have added/updated code comments
  • I have updated the CHANGELOG.md

Testing

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested edge cases
  • I have tested error conditions

Security & Safety

  • My changes don't introduce security vulnerabilities
  • I haven't committed any secrets or sensitive data
  • I've considered the impact on existing users
  • I've followed Clarity best practices

Screenshots (if applicable)

Additional Context

Deployment Considerations

  • Requires contract deployment
  • Requires data migration
  • Requires configuration changes
  • Backward compatible

By submitting this PR, I confirm that:

  • My contribution is made under the MIT License
  • I have read and followed the CONTRIBUTING.md guidelines
  • I am the original author or have permission to contribute this code