Example in the README is broken
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23.1k
- Forks
- 1.1k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 9
Description
This example does not work.
The problem comes from this commit. It changes the example file, which seems to cause some hash mismatch. When it is reverted, the example works. Shown below in this screenshot.
Contributor guide
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
Start with the README section linked in the issue and compare its example with the changes in commit 72c0ab63a622aae90cc4347e2a3d14ec1761e3b2. Run the linked example and investigate the reported hash mismatch; done means the README example works with the current example file and no mismatch occurs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, security
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100