whitesmith / whitesmith/rubycritic
Define a first version of our public API
Open
Nobody has claimed this yet.
discussion
feature
- Dominant language
- Ruby
- Stars
- 3.5k
- Forks
- 234
- PR merge metrics
- No merged PRs in 30d
Description
Originated from #92
Let's discuss! So far I have no opinion. It might make sense to streamline all of our analyzers first though.
Right now they have subtle differences which prevent us from doing so.
I'd suggest to iron out those kinks first and define a first draft.
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 by reviewing the originating issue #92 and the current analyzers, whose subtle differences are identified as a blocker. Compare their interfaces and determine which inconsistencies must be resolved before drafting a public API. Done means a first API draft exists and the analyzer differences have been addressed or explicitly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100