linkerd / linkerd/linkerd2-conformance
docs restructuring
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Following https://github.com/linkerd/linkerd2-conformance/pull/1#discussion_r457899878 , we want to restructure the README a bit and also move the "Adding new tests" section to a separate `CONTRIBUTING.md`, that elucidates how contributors can add new tests, run tests locally, and also build their own versions of docker images for testing with Sonobuoy.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the README and the linked pull request discussion first. Restructure the README and create CONTRIBUTING.md covering how to add new tests, run tests locally, and build Docker images for Sonobuoy testing; the documentation is complete when all three workflows are explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- build-system, documentation, testing
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100