Skip to content

build(.gitignore): ignore pyrightconfig.json and poetry.toml #1483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 30 commits into
base: refactors
Choose a base branch
from

Conversation

gbaian10
Copy link
Contributor

Description

I referred to the .gitignore template from this webpage and suggest adding two items to be ignored:

  1. pyrightconfig.json – For users who use VS Code, they might have their own preferred configurations for pyright/pylance.

  2. poetry.toml – This repository uses Poetry to manage packages. This file can be used to configure some Poetry-related environment variables for the project, such as creating the virtual environment inside the project directory instead of under the .cache folder in the home directory.

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
    • Check if there are any broken links in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Steps to Test This Pull Request

Additional Context

bearomorphism and others added 30 commits May 31, 2025 13:07
Since the project requires Python >=3.9, argparse only raises SystemExit
when non-existent commands are provided, making TypeError handling unnecessary.
Copy link

codecov bot commented May 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.82%. Comparing base (59fd3f5) to head (852b71d).
Report is 2 commits behind head on refactors.

Additional details and impacted files
@@            Coverage Diff             @@
##           refactors    #1483   +/-   ##
==========================================
  Coverage      97.82%   97.82%           
==========================================
  Files             57       57           
  Lines           2619     2619           
==========================================
  Hits            2562     2562           
  Misses            57       57           
Flag Coverage Δ
unittests 97.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.


### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm kinda curious what the behavior you decide but we shouldn't add it to commitizen

@@ -113,3 +113,10 @@ venv.bak/

# ruff
.ruff_cache

# LSP config files
pyrightconfig.json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest adding it to your ~/.gitignore instead. I don't like to add things to ignore that's not directly related to commitizen (yep ".vscode" is kinda not my taste either)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants