docs: moved the policy regarding commits from when it was running locally to the contributor page #11701
Conversation
docs/CONTRIBUTING.md
Outdated
| TroubleShooting: | ||
|
|
||
| * When running `make pre-commit -B`, if you encounter errors like | ||
| `make: *** [pkg/apiclient/clusterworkflowtemplate/cluster-workflow-template.swagger.json] Error 1`, ensure that you | ||
| have checked out your code into `$GOPATH/src/github.com/argoproj/argo-workflows`. |
There was a problem hiding this comment.
But this pre-commit requires installing the toolchain which are listed in running-locally document.
There was a problem hiding this comment.
Yea this may make more sense to just link out to running-locally.md#committing
There was a problem hiding this comment.
Thank you for your review! :)
Based on your feedback, I have kept the Committing-related information in the "running locally" file as is, and added a link to the Committing section within the "running locally" file to the "contributing" file.
This is expected to make it easier for developers to find the commit guidelines for PRs.
Signed-off-by: sunyeongchoi <sn0716@naver.com>
sunyeongchoi
force-pushed
the
docs-commit
branch
from
52ed42f
to
3cf21b4
Compare
There was a problem hiding this comment.
Works for me. And I think you have a good point with getting these into the main CONTRIBUTING.md docs. I didn't realize they weren't already there! (one of those things where you learn it once and then don't look too often after)
An alternative may be to add the guidelines in CONTRIBUTING.md, then link to Running Locally for running pre-commit.
Do you want to add the links you added before into the Running Locally page?
Signed-off-by: sunyeongchoi <sn0716@naver.com>
Signed-off-by: sunyeongchoi <sn0716@naver.com> Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: happyso <sn0716@naver.com>
Fixes #11700
Motivation
Modifications
moved the policy regarding commits from when it was running locally to the contributor page and I have also improved some links related to commits
Verification