Improve terminology
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 45
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Currently interfaces which are responsible for displaying logs are called writers, which can be confusing, as in similar way we may think of as a writer of interface through which logs are written (to the registry).
In popular loggers what's called writers is called transports or reporters. At this point I'm leaning towards reporter term (altough it's not just about writing but also about transformations to logs, and it's what transports do)
Such change will need to be followed with rename of *-writer modules, hence it'll be breaking
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
Start by reviewing the existing *-writer modules and their usages. Resolve whether the project will use “reporter” or another term, then rename the modules and references consistently; done means the terminology is updated throughout despite the noted breaking change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- observability-sre
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100