posit-dev / posit-dev/open-source-website
Pre-commit hook: check rendered .md is staged with .qmd
Open
Nobody has claimed this yet.
blog
- Dominant language
- HTML
- Stars
- 55
- Forks
- 24
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 17
Description
When a .qmd file is staged for commit, a pre-commit hook should verify the corresponding rendered .md is also staged and up to date. This catches forgotten re-renders before they reach the repo.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the repository's pre-commit configuration and the workflow for rendering staged .qmd files to .md. Determine how corresponding files are mapped and how freshness can be checked. Done means a commit with a staged .qmd but no staged, up-to-date .md is rejected, while valid pairs pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100