grpc-ecosystem/grpc-gateway

docs: Improve documentation about http options

Open

#295 opened on Jan 10, 2017

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Go (2,250 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (PR metrics pending)

Description

I keep having to inspect the source code to remember how to declare http options that include values in the path.

Contributor guide

Research direction
Examine the source code to understand how HTTP options with path values are declared, then add clear documentation examples.
Tech stack
go
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85