Make a nixpkgs auto reply action for docs prs pointing to docs guidelines and specific contribution info
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Observations
Can be easy to put docs in the wrong place or in the wrong style for the place due to issues communicating our values for docs, and this has burned out at least one contributor this week.
Problem
Docs specific contribution info isn't surfaced when making docs affecting prs on Nix and nixpkgs.
Approaches
We could make an auto reply action that finds if it touches the right sub tree and adds a little message linking to the nix.dev docs contribution info.
Willing to help?
Yeah
Priorities
Add 👍 to issues you find important.
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 reviewing the repository's existing GitHub Actions and the nix.dev documentation contribution information referenced by the issue. Determine how docs-affecting pull requests and the relevant subtree should be identified, then define the auto-reply content and its links. Done means the action posts the guidance only for matching pull requests; no file or test is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100