Add comprehensive mixin documentation with timestamps and soft delete patterns#24
Merged
Add comprehensive mixin documentation with timestamps and soft delete patterns#24
Conversation
… examples Co-authored-by: ichiriac <173203+ichiriac@users.noreply.github.com>
Co-authored-by: ichiriac <173203+ichiriac@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update mixin documentation with examples and timestamps
Add comprehensive mixin documentation with timestamps and soft delete patterns
Jan 17, 2026
ichiriac
approved these changes
Jan 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The mixin documentation lacked practical examples for common patterns like timestamp tracking and soft deletes, particularly how to override lifecycle methods like
unlink().Documentation Changes (
docs/mixins.md)Extension vs Composition: Clarified two mixin patterns - registering multiple classes with same
static _namevs usingstatic mixins = [...]Timestamps Mixin: Full
Timestampableimplementation usingpre_create/pre_updatehooks to auto-managecreated_at/updated_atfieldsSoft Delete Mixin: Complete
SoftDeletablepattern overridingunlink()to setdeleted_atinstead of deleting, withrestore(),forceUnlink(), and default scope to hide deleted recordsActivity Tracking: Polymorphic relations example for generic activity logging
Best Practices: Combining multiple mixins, conflict resolution, abstract models
Working Demo (
demo/mixins/)Runnable examples with:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.