Skip to content
This repository was archived by the owner on Nov 26, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.12
6 changes: 6 additions & 0 deletions main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
def main():
print("Hello from pre-commit-configs!")


if __name__ == "__main__":
main()
Comment on lines +1 to +6

Choose a reason for hiding this comment

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

medium

To improve maintainability and adhere to Python best practices (PEP 257), it's recommended to add docstrings to both the module and the function.1

  • A module docstring at the top of the file explains the script's purpose.
  • A function docstring explains what the function does.

I've also adjusted the spacing to follow common Python style.

Suggested change
def main():
print("Hello from pre-commit-configs!")
if __name__ == "__main__":
main()
"""Main script for pre-commit-configs."""
def main():
"""Run the main logic of the script."""
print("Hello from pre-commit-configs!")
if __name__ == "__main__":
main()

Style Guide References

Footnotes

  1. PEP 257 recommends docstrings for all public modules, functions, classes, and methods.

7 changes: 7 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[project]
name = "pre-commit-configs"
version = "0.1.0"
description = "Add your description here"

Choose a reason for hiding this comment

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

medium

The project description is a placeholder. Please update it with a meaningful description of the project's purpose.

readme = "README.md"

Choose a reason for hiding this comment

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

medium

This line references a README.md file, but this file is not included in the pull request. This will cause errors when building the package. Please either add a README.md file to the project or remove this line if a README is not intended.

requires-python = ">=3.12"
dependencies = []