ipfs / ipfs/go-metrics-prometheus

This repo is missing a README

Open Beginner friendly
#2 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
9
Forks
4
PR merge metrics
No merged PRs in 30d

Description

As part of ipfs/docs#55, we’re trying to make sure every repo has a useful readme and description. `go-metrics-prometheus` has a description, but no README at all, so we should make sure we add one.

It doesn’t need to be too special, but we should at least explain:

- Name
- More detailed description that the GitHub description field (even if it’s only one short paragraph). Try and say how it fits into IPFS (e.g. `go-ipfs` relies on this module to send metrics when you configure xyz).
- How to install (even if just `go get xyz` or `git clone xyz`)
- [Standard license text](https://github.com/ipfs/community/blob/master/LICENSING_POLICY.md) — you can pretty much just copy & paste.
- Bonus points for a usage example if it’s easy to whip one up!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the repository description and the licensing policy linked in the issue. Add a README covering the project name, its relationship to IPFS, installation, and the standard license text; include a usage example if the repository makes one straightforward. Done means the repository has a useful README with the requested sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.