Skip to content

Conversation

2ykwang
Copy link
Member

@2ykwang 2ykwang commented Jul 23, 2025

Add a sample Django project for testing auditlog functionality.

Makes it easier for developers to quickly test auditlog behavior and reproduce issues.

(based on my testing setup - feedback appreciated!)

2ykwang added 5 commits July 24, 2025 02:18
- Add Django project configuration (settings, urls, wsgi, asgi)
- Add demo app with basic structure
- Add requirements.txt with Django and auditlog dependencies
- Add management script for running the sample project
- Add Post, Category, Tag models demonstrating various field types
@2ykwang 2ykwang requested a review from hramezani July 23, 2025 17:37
@2ykwang 2ykwang self-assigned this Jul 23, 2025
Copy link

codecov bot commented Jul 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.80%. Comparing base (d4d9f28) to head (526da4e).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #741   +/-   ##
=======================================
  Coverage   95.80%   95.80%           
=======================================
  Files          33       33           
  Lines        1144     1144           
=======================================
  Hits         1096     1096           
  Misses         48       48           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@hramezani
Copy link
Member

Thanks @2ykwang for this PR.

Not sure we want to include this project in the code base because we need to take care of the code. I'm afraid the code becomes out of date at some point because we don't have a test for the code.

@2ykwang
Copy link
Member Author

2ykwang commented Jul 24, 2025

Thanks feedback! @hramezani

is the demo project unnecessary, or would you consider merging it if we establish a maintenance plan? Including a demo helps users and maintainers verify features quickly, and many popular OSS projects use a top-level examples/ or tutorial/ directory so with a clear update strategy, it should be fine.

@hramezani
Copy link
Member

Thanks feedback! @hramezani

is the demo project unnecessary, or would you consider merging it if we establish a maintenance plan? Including a demo helps users and maintainers verify features quickly, and many popular OSS projects use a top-level examples/ or tutorial/ directory so with a clear update strategy, it should be fine.

Having the demo project is good. We need to keep the project updated and make sure that it doesn't break. So, I am mostly worry about the maintenance

@2ykwang
Copy link
Member Author

2ykwang commented Jul 30, 2025

That makes sense. I’ll this PR to a draft for now and I’ll review the maintenance plan for the demo project and check if it’s really necessary, then update it again!

@hramezani

@2ykwang 2ykwang marked this pull request as draft July 30, 2025 23:28
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