linkerd / linkerd/linkerd-examples

Add CONTRIBUTING.md

Open
#131 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
444
Forks
216
PR merge metrics
No merged PRs in 30d

Description

re: https://github.com/linkerd/linkerd-examples/pull/129

The codebase has some conventions/tribal knowledge that would be good to put into a written format.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the referenced pull request #129 and inspect the repository for the conventions and tribal knowledge it exposes. Add CONTRIBUTING.md documenting those project practices; the work is done when contributors have a written guide covering the relevant conventions.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.