summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authora1012112796 <1012112796@qq.com>2022-01-18 02:39:07 +0800
committerGitHub <noreply@github.com>2022-01-17 13:39:07 -0500
commit8581e2f4ecfc4b4a1d9f87a40fffe5b293477580 (patch)
tree49b1a1b73964160828c214c963f1535fdbc39e3e /CONTRIBUTING.md
parent076cead40dd4cd498a70f4bd09b0f0077b26144e (diff)
downloadgitea-8581e2f4ecfc4b4a1d9f87a40fffe5b293477580.tar.gz
gitea-8581e2f4ecfc4b4a1d9f87a40fffe5b293477580.zip
update description about vendoring in CONTRIBUTING.md (#18280)
* update description about vendoring in CONTRIBUTING.md follow #18277 Signed-off-by: a1012112796 <1012112796@qq.com> * Update CONTRIBUTING.md Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> * fix and readd test-vendor step * remove vendor from .gitattributes @silverwind * simplify go mod check Signed-off-by: a1012112796 <1012112796@qq.com> * Revert "remove vendor from .gitattributes @silverwind" This reverts commit 4789e704cb7a2c80934e4a4cd31efb161e6c8666. Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: 6543 <6543@obermui.de>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fad535bb2a..624896bbaa 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -91,13 +91,12 @@ Here's how to run the test suite:
## Vendoring
-We keep a cached copy of dependencies within the `vendor/` directory,
-managing updates via [Modules](https://golang.org/cmd/go/#hdr-Module_maintenance).
+We manage dependencies via [Go Modules](https://golang.org/cmd/go/#hdr-Module_maintenance), more details: [go mod](https://go.dev/ref/mod).
-Pull requests should only include `vendor/` updates if they are part of
+Pull requests should only include `go.mod`, `go.sum` updates if they are part of
the same change, be it a bugfix or a feature addition.
-The `vendor/` update needs to be justified as part of the PR description,
+The `go.mod`, `go.sum` update needs to be justified as part of the PR description,
and must be verified by the reviewers and/or merger to always reference
an existing upstream commit.