Make a nixpkgs auto reply action for docs prs pointing to docs guidelines and specific contribution info
lf- opened this issue · comments
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.
I suppose this could be solved by adding a link to the (ever-growing) Nixpkgs contribution guide.
I suppose this could be solved by adding a link to the (ever-growing) Nixpkgs contribution guide.
I think it would explicitly be made worse by doing that because that's already in the PR template and nobody reads it. The contribution guide is long and mostly explains how we use git, and even if people do read it, it's not getting across the vision stuff. We need to link to something which explains clearly where every docs type belongs and the overall vision of docs and a style guide, and explicitly doesn't explain git.