typescript-eslint / typescript-eslint/performance
📝 Documentation: Add quick guide to making a new benchmark
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 6
- Forks
- 1
- Avg merge
- 45m
- Merged PRs (30d)
- 7
Description
Bug Report Checklist
- I have pulled the latest
mainbranch of the repository. - I have searched for related issues and found none that matched my issue.
Overview
I posted a link to this repo in https://github.com/typescript-eslint/typescript-eslint/issues/11241#issuecomment-2905306843 as a potential starting base for perf comparisons. Then I realized - it's not really clear how to do that. The docs in this repo are sparse and don't mention how to set up a new comparison. Proposal: let's add those docs in?
Additional Info
No response
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
Review the repository's existing documentation on the latest main branch, then trace how a new performance comparison is set up. Done when a newcomer can follow a concise quick guide to create a new benchmark comparison and understand the expected result.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, performance
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100