Skip to content

Add poetry.toml to Python.gitignore (optional Poetry config file) #4653

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

Merged
merged 1 commit into from
Jun 2, 2025

Conversation

vicman7
Copy link
Contributor

@vicman7 vicman7 commented May 31, 2025

Reasons for making this change

This change adds .poetry.toml to the Python .gitignore file.

.poetry.toml is a configuration file used by Poetry, a widely adopted dependency management and packaging tool in the Python ecosystem. While .poetry.toml is typically used for local configuration (e.g. virtualenv location or group settings), it often contains machine-specific paths and preferences that should not be committed to version control. This makes it a good candidate for inclusion in .gitignore.

The change follows the convention already applied in the template for similar tools like Pipenv and PDM, where their lock/config files are commented out or ignored based on user/project preference.

Links to documentation supporting these rule changes

If this is a new template

Not a new template; this is a change to the existing Python template.

Merge and Approval Steps

  • Confirm that you've read the contribution guidelines and ensured your PR aligns
  • Ensure CI is passing
  • Get a review and approval from one of the maintainers
@vicman7 vicman7 requested a review from a team as a code owner May 31, 2025 21:16
Copy link
Collaborator

@dooleydevin dooleydevin left a comment

Choose a reason for hiding this comment

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

Thanks for this! I agree this is probably an optional change for most repositories, and think having it commented here makes sense 👍

@dooleydevin dooleydevin merged commit 136f98d into github:main Jun 2, 2025
@vicman7 vicman7 deleted the add-poetry-toml branch June 3, 2025 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants