jazzband / django-fsm-log

Automatic logging for Django FSM
https://django-fsm-log.readthedocs.io/en/latest/
MIT License
242 stars 78 forks source link

Deprecate StateLog model, to instead, bring your own model. #176

Open ticosax opened 1 year ago

ticosax commented 1 year ago

This is an implementation that support the idea exposed in https://github.com/jazzband/django-fsm-log/discussions/133

It's still a Draft, I'm open for any feedback more specifically around the names. Not tested yet with a real project.

It's meant to be completely backward compatible.

codecov[bot] commented 1 year ago

Codecov Report

Merging #176 (39ac59d) into master (06422d5) will decrease coverage by 0.26%. The diff coverage is 92.91%.

:exclamation: Current head 39ac59d differs from pull request most recent head 9262180. Consider uploading reports for the commit 9262180 to get more accurate results

@@            Coverage Diff             @@
##           master     #176      +/-   ##
==========================================
- Coverage   97.28%   97.02%   -0.26%     
==========================================
  Files          24       25       +1     
  Lines         516      572      +56     
==========================================
+ Hits          502      555      +53     
- Misses         14       17       +3     
Impacted Files Coverage Δ
...ango_fsm_log/migrations/0004_auto_20190131_0341.py 100.00% <ø> (ø)
django_fsm_log/backends.py 81.25% <50.00%> (+0.21%) :arrow_up:
django_fsm_log/admin.py 90.00% <75.00%> (-10.00%) :arrow_down:
django_fsm_log/apps.py 100.00% <100.00%> (ø)
django_fsm_log/conf.py 100.00% <100.00%> (ø)
django_fsm_log/managers.py 100.00% <100.00%> (ø)
django_fsm_log/migrations/0001_initial.py 100.00% <100.00%> (ø)
django_fsm_log/models.py 100.00% <100.00%> (ø)
tests/admin.py 100.00% <100.00%> (ø)
tests/conftest.py 100.00% <100.00%> (ø)
... and 6 more

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

samuel-andres commented 1 year ago

What happened with this? 👀

thomasmassmann commented 7 months ago

@ticosax , do you need some help finishing this PR?

ticosax commented 7 months ago

@thomasmassmann If I recall correctly, I left it in an alpha state. It's meant to be testable with existing projects. What needs to be done is to check/develop a migration path, enhance the documentation around that transition, catch bugs, and make sure we can offer a smooth transition with clear guidelines, before making a major release.

Unfortunately I'm not using Django at the moment, which means I can't commit time to it. But hopefully this work can be continued by more contributors.

thomasmassmann commented 7 months ago

@thomasmassmann If I recall correctly, I left it in an alpha state. It's meant to be testable with existing projects. What needs to be done is to check/develop a migration path, enhance the documentation around that transition, catch bugs, and make sure we can offer a smooth transition with clear guidelines, before making a major release.

Unfortunately I'm not using Django at the moment, which means I can't commit time to it. But hopefully this work can be continued by more contributors.

I’m working on a bigger Django project where I would like to use it and would need those changes being available. Depending on the importance of this for the stakeholders, I could be stepping in in the second half of this year.

What would be your preferred way for contribution? Continue in your fork or create a new fork of your changes?

ticosax commented 7 months ago

What would be your preferred way for contribution? Continue in your fork or create a new fork of your changes?

I don't want to stay in the way. I think it's preferable that you clone the PR and then you re-submit a new PR from your fork. As long as you keep attributions to my identity, make the process as easy as you'd like. I'm also okay with rebasing and squashing the existing commits if that's what you prefer.