Skip to content

Conversation

@jrowah
Copy link
Contributor

@jrowah jrowah commented Nov 7, 2025

Description

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
  • πŸ”§ Refactoring (no functional changes)
  • 🎨 Style changes (formatting, missing semi colons, etc)
  • πŸš€ Performance improvement
  • πŸ§ͺ Test improvements
  • πŸ”’ Security improvement

Related Issues

  • Closes #
  • Relates to #

Changes Made

  • Change 1
  • Change 2
  • Change 3

Testing

Test Coverage

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing completed

Test Results

  • All existing tests pass
  • New tests pass
  • No decrease in test coverage

Manual Testing

Screenshots (if applicable)

Database Changes

  • No database changes
  • Migration files added
  • Database changes are backward compatible
  • Database changes require data migration

Breaking Changes

  • No breaking changes
  • Breaking changes documented
  • Migration guide provided

Security Considerations

  • No security implications
  • Security review completed
  • Input validation added/updated
  • Authentication/authorization changes reviewed

Performance Impact

  • No performance impact
  • Performance improvement
  • Performance impact acceptable
  • Performance testing completed

Documentation

  • Code is self-documenting
  • Inline comments added where necessary
  • README updated (if needed)
  • API documentation updated (if needed)
  • Contributing guidelines followed

Checklist

  • I have read and followed the Contributing Guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • 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
  • Any dependent changes have been merged and published

Code Quality

  • Code follows the project's style guidelines
  • mix format has been run
  • mix credo --strict passes
  • mix dialyzer passes (if applicable)
  • No TODO comments left in code

Deployment Notes

  • No special deployment steps required
  • Environment variables added/updated (documented in PR)
  • Configuration changes required (documented)
  • Database migration required

Additional Notes

Reviewer Guidelines

Please review:

  • Code quality and adherence to standards
  • Test coverage and quality
  • Security implications
  • Performance impact
  • Documentation completeness
  • Breaking changes and backward compatibility

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