Skip to content
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

Add .pdm-python file to Python.patch #553

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

menzenski
Copy link

Per the PDM documentation, the .pdm-python file should not be committed.

https://pdm-project.org/latest/usage/project/#working-with-version-control

Pull Request

Thank you for contributing to @toptal/gitignore and https://www.gitignore.io.

New or update

Select the appropriate check box for this pull request. This helps when merging to ensure there are no conflicts with other templates or misunderstandings of how thee template list works.

New

  • Template - New .gitignore template
  • Composition - Template made from smaller templates
  • Inheritance - Template similar to an existing template
  • Patch - Template extending functionality of existing template

Update

  • Template - Update existing .gitignore template

Details

Per https://github.com/toptal/gitignore/blob/7e72ecd8af69b39c25aedc645117f0dc261cedfd/.github/CONTRIBUTING.md I am updating the Python.patch file rather than the Python.gitignore file, as the latter exists in the base github/gitignore repository.

Here's the relevant information from the PDM documentation about this specific change:

You must commit the pyproject.toml file. You should commit the pdm.lock and pdm.toml file. Do not commit the .pdm-python file.

and

.pdm-python stores the Python path used by the current project and doesn't need to be shared.

Per the PDM documentation the .pdm-python file shouldn't be committed.
@menzenski menzenski requested a review from a team as a code owner November 25, 2023 15:57
@menzenski menzenski requested review from filipechagas and alexmcode and removed request for a team November 25, 2023 15:57
@filipechagas filipechagas removed their request for review November 29, 2023 19:56
@baggiponte
Copy link

that's great, I always use PDM and have to change the settings. The official .gitignore by PDM ignores the following files:

.pdm.toml
.pdm-python
.pdm-build/

Could you add .pdm-build to the list? Hope it gets reviewed soon.

@baggiponte
Copy link

@edgarrmondragon can I bother with reviewing this? Thank you.

@edgarrmondragon
Copy link

@edgarrmondragon can I bother with reviewing this? Thank you.

Sorry, I'm not familiar with pdm 😅

@baggiponte
Copy link

@edgarrmondragon can I bother with reviewing this? Thank you.

Sorry, I'm not familiar with pdm 😅

Ops, sorry. I am using PDM extensively, I noticed these files are ignored. I looked into the source code and found they are ignored here. Could they be added to the patch?

@menzenski
Copy link
Author

@baggiponte updated

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