Skip to content

Add pre-commit config and CONTRIBUTING.md - #117

Closed
Larslllllll wants to merge 2 commits into
codeforstartups:developmentfrom
Larslllllll:development
Closed

Larslllllll wants to merge 2 commits into
codeforstartups:developmentfrom
Larslllllll:development

Conversation

@Larslllllll

Copy link
Copy Markdown

Summary

  • Add .pre-commit-config.yaml with ruff + basic hooks (trailing-whitespace, end-of-file-fixer)
  • Add CONTRIBUTING.md with development workflow documentation

Acceptance Criteria

  • .pre-commit-config.yaml (ruff, trailing-whitespace, eof)
  • Docs in CONTRIBUTING

Closes #113

Lars added 2 commits September 6, 2026 09:00
- Add .pre-commit-config.yaml with ruff + basic hooks (trailing-whitespace, end-of-file-fixer)
- Add CONTRIBUTING.md with development workflow documentation

Closes codeforstartups#113
- Add Python 3.13 to the test matrix
- Add pip-audit job for dependency vulnerability scanning

Closes codeforstartups#114, Closes codeforstartups#115

@codeforstartups codeforstartups left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks @Larslllllll — the pre-commit config and CONTRIBUTING.md are excellent and I'd love to merge them. Two things to fix first:

  1. pip-audit step is misconfigured and would fail CI on development:
    • pypa/gh-action-pip-audit has no requirements: input, and pyproject.toml isn't a requirements file.
    • Use the local-project mode instead:
        - name: Run pip-audit
          uses: pypa/gh-action-pip-audit@v1.1.0
          with:
            inputs: .
  2. Overlap with #118 — both PRs make the identical ci.yml change (add 3.13 + a security job). Let's land the ci.yml change in exactly one PR. Since this PR also brings pre-commit + CONTRIBUTING, I'd suggest this one own it, and we close #118 (or trim #118 to nothing).

Once the pip-audit step is fixed I'll merge. Really nice contribution!

@codeforstartups

Copy link
Copy Markdown
Owner

👋 The pre-commit config + CONTRIBUTING.md are ready to merge — the only blocker is the same pip-audit step:

      - name: Run pip-audit
        uses: pypa/gh-action-pip-audit@v1.1.0
        with:
          inputs: .        # not: requirements: pyproject.toml

Fix that (or drop the security job into its own follow-up PR) and I'll merge this. If you'd rather ship the docs/pre-commit now, remove the ci.yml hunk here and I'll merge immediately.

@codeforstartups

Copy link
Copy Markdown
Owner

Superseded by #160 (now merged), which adds the pre-commit config + CONTRIBUTING.md without the broken pip-audit CI job. Thank you @Larslllllll for kicking this off — closing in favor of #160. The 3.13 matrix from your #118 lives on in #158.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a pre-commit config

2 participants