New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify which doc version to fix #4895

Open

t-kikuc opened this issue Apr 23, 2024 · 0 comments

Labels

area/docs kind/enhancement

Member

t-kikuc commented Apr 23, 2024

What would you like to be added:

Redefine and clarify the rule of contributing to docs, focusing on which doc version to fix.
cf. Our current rule: https://github.com/pipe-cd/pipecd/tree/master/docs
[optional] If possible, it would be better to inform contributors before opening PRs.
(e.g. Auto check in CI? PullRequest template?)

Why is this needed:

Newer contributors often make mistakes of which version to fix (dev, v0.N.x(latest), and older)
It takes time for both contributors and reviewers to fix it.

t-kikuc added kind/enhancement area/docs labels

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