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.

Sign up for GitHub

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

Jump to bottom

Enhancement #11

Closed
wants to merge 8 commits into from
Closed

Enhancement #11

wants to merge 8 commits into from

Conversation

nifedara
Copy link
Owner

@nifedara nifedara commented Jun 11, 2024 •
edited
Loading

What does this PR do?

Resolves Integrate Pre-commit Hooks and Dependency Management

Consideration

  • These are sample hooks. More can be added
  • I am yet to add documentation for them

Why choices of pre-commit hook

  • check-yaml: Loads all yaml files to verify the syntax
  • end-of-file-fixer: Makes sure files end in a newline and only a newline
  • trailing-whitespace: Trims trailing whitespace. ..more
  • ruff: Fast Python linter and code formatter, written in Rust.
  • commitizen: Enforces writing descriptive commits and makes commits easier to read

Why pdm for dependency management

  • pdm: a modern Python package and dependency manager that supports the latest PEP standards

kshitijrajsharma
kshitijrajsharma suggested changes Jun 19, 2024
View reviewed changes
Copy link

@kshitijrajsharma kshitijrajsharma left a comment

Choose a reason for hiding this comment

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

Request to remove pdm.lock , Add commitizen block in toml file

backend/pyproject.toml
[tool.pdm]
distribution = true

[tool.pdm.dev-dependencies]
Copy link

Choose a reason for hiding this comment

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

We need one more section which is commitizen

backend/pdm.lock Outdated
Copy link

Choose a reason for hiding this comment

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

No need to add pdm.lock

@kshitijrajsharma
Copy link

Please provide Readme in the installation doc about how to install using pdm

@nifedara nifedara closed this Jun 22, 2024
@nifedara nifedara deleted the enhancement branch June 22, 2024 07:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kshitijrajsharma kshitijrajsharma kshitijrajsharma requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Integrate Pre-commit Hooks and Dependency Management methods on the backend
2 participants
@nifedara @kshitijrajsharma