Add FAQ explaining why Pydantic is not used#1489
Merged
Lee-W merged 1 commit intocommitizen-tools:masterfrom Jun 8, 2025
Merged
Add FAQ explaining why Pydantic is not used#1489Lee-W merged 1 commit intocommitizen-tools:masterfrom
Lee-W merged 1 commit intocommitizen-tools:masterfrom
Conversation
7af5bb3 to
a5073f2
Compare
Collaborator
|
Hi @AnasHasan786 , please follow the Conventional Commit pattern in your commit messages. |
Collaborator
|
And please run the following commands to setup pre-commit hooks in your local environment. poetry setup-pre-commitHope this helps! |
91dd39d to
f4b7d4e
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1489 +/- ##
==========================================
+ Coverage 97.33% 97.62% +0.28%
==========================================
Files 42 57 +15
Lines 2104 2653 +549
==========================================
+ Hits 2048 2590 +542
- Misses 56 63 +7
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
c253330 to
8d24951
Compare
Lee-W
approved these changes
Jun 8, 2025
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.
Description
Added an FAQ entry explaining why the project avoids using Pydantic, highlighting reasons such as dependency minimization, avoiding version conflicts, and preferring built-in alternatives like
TypedDict.Checklist
Code Changes
poetry alllocally to ensure this change passes linter check and testsDocumentation Changes
poetry doclocally to ensure the documentation pages render correctlyExpected Behavior
The FAQ page should render correctly and clearly explain why Pydantic is not used in the project.
Steps to Test This Pull Request
poetry docfaq.mdAdditional Context
Closes: #1488