Skip to content

feat: check for a gitignore file#827

Merged
henryiii merged 1 commit into
scientific-python:mainfrom
w3lld1:feat/gitignore-check
Jul 17, 2026
Merged

feat: check for a gitignore file#827
henryiii merged 1 commit into
scientific-python:mainfrom
w3lld1:feat/gitignore-check

Conversation

@w3lld1

@w3lld1 w3lld1 commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add PY008 to check that a project has a root .gitignore file
  • cover present, missing, and directory-instead-of-file cases
  • connect the new check to the packaging guide and regenerate the README check list

Validation

  • uv run pytest -q — 257 passed, 1 skipped (the existing rate-limit-sensitive package test)
  • uvx nox -s rr_lint
  • uvx nox -s rr_pylint — 10.00/10
  • uvx nox -s readme
  • NODE_OPTIONS='--no-deprecation' npx --yes mystmd@^1.0 build --html
  • git diff --check

The exact bun run build wrapper was not run locally because Bun is unavailable in this environment; the MyST HTML build itself completed successfully via npx.

Fixes #822


📚 Documentation preview 📚: https://scientific-python-cookie--827.org.readthedocs.build/

@henryiii

Copy link
Copy Markdown
Collaborator

This is a good idea, thanks! Checking for a file is free in the Wasm version (it reads the file list from the API up front), so this isn't even an extra request.

@henryiii
henryiii merged commit 0b7921d into scientific-python:main Jul 17, 2026
22 checks passed
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.

feature proposal: additional rule .gitignore, section PY

2 participants