grpc-ecosystem/grpc-gateway

docs: provide some common vendoring tips/pitfalls

Open

#365 opened on Apr 18, 2017

View on GitHub
 (8 comments) (2 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
documentationhelp wanted

Description

sharing some information about how folks approach vendoring with different tools and perhaps noting some gotchas would be valuable for users.

Contributor guide

Tech stack
go
Domain
apibackenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go vendoring experience
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Look into common vendoring tools (e.g., dep, Go modules) and document pitfalls mentioned in the community. Check existing documentation in the grpc gateway repo, especially the docs/ folder, and compile tips from the issue comments (e.g., #365 comment xxx). Also review any related PRs or discussions about vendoring in the project.