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

Documentation page on what to commit to version control #1364

Closed
gjoseph92 opened this issue Sep 7, 2022 · 1 comment · Fixed by #1373
Closed

Documentation page on what to commit to version control #1364

gjoseph92 opened this issue Sep 7, 2022 · 1 comment · Fixed by #1373
Labels
📖 documentation Improvements or additions to documentation ❓ help wanted Extra attention is needed

Comments

@gjoseph92
Copy link

Is your feature request related to a problem? Please describe.

For beginners, a clear section instructing them what to track (and not track) in version control might be helpful. For comparison, poetry has this: https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control.

Describe the solution you'd like

A "Working with version control" section under https://pdm.fming.dev/latest/usage/project/ recommending that you:

  • Always commit pyproject.toml
  • Almost always commit pdm.lock so other devs can contribute to the project in an identical environment, so you can re-use that environment in CI, etc.
  • Add .pdm.toml to your .gitignore and don't commit it (I'm not actually sure about this—is it guaranteed to only contain machine-specific config?)
@gjoseph92 gjoseph92 added the ⭐ enhancement Improvements for existing features label Sep 7, 2022
@frostming frostming added 📖 documentation Improvements or additions to documentation ❓ help wanted Extra attention is needed and removed ⭐ enhancement Improvements for existing features labels Sep 7, 2022
@Beartime234
Copy link
Contributor

Suggested section in PR above. Umm'd and Ahh'd about the wording so feel free to critque/change.
#1373

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation ❓ help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants