-
Notifications
You must be signed in to change notification settings - Fork 49
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add typos tool to CI to automate typo detection #76
Conversation
f57fa4c
to
ddec934
Compare
5bcf773
to
10bc1f6
Compare
Hey! I totally approve of your idea to automate typo detection. I have even personally suggested it to folks in the past. But you have totally misunderstood my intentions here. Since you have taken the time to go through my recent PR contributions, I would suggest that you go back and check all my PR contributions AND bug reports over the years. While you will find many typo fixing PRs as it's a low hanging fruit and I'm not a developer but a tech fan and I do it just for fun, you will also find that I have contributed in very diverse projects that have no connection to crypto whatsoever. So if my intention would be to farm PRs why would I waste my effort and contribute to projects I have nothing to gain from? The answer is that I do it only for projects I like for different reasons and it's my way to say thanks to the developers. But after reading your reasoning, I do see why you would think I am a "PR farmer". By the way, this is the first time I stumble upon this term! Anyway, no hard feelings and keep doing what you are doing :) |
d32b76e
to
6c4191a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is really cool, lgtm!
6c4191a
to
39e0fc4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Thanks for addressing this.
Motivation:
Since recently more projects are starting to do airdrops and using lists of repositories to reward contributors (eg. Namada, StarkWare, etc), a new wave of airdrop farmers has emerged, no longer collecting discord chat points but now going after code contributions.
In the era of bots and automation, we must protect humans attention and time, and in this case we can avoid spending time on airdrop-farmers PRs that could simply be avoided by having our own automated tool.
This has been already a problem to other projects, we were postponing it but seems that we are now target too: #75
A quick look at the PR author profile shows some other PRs from the same user executing a typo-finding-tool and opening PRs (listing here only few):
privacy-scaling-explorations/snark-verifier#60
privacy-scaling-explorations/chiquito#210
privacy-scaling-explorations/zk-kit#182
privacy-scaling-explorations/halo2curves#140
privacy-scaling-explorations/p0tion#266
privacy-scaling-explorations/maci#1245
privacy-scaling-explorations/zkevm-circuits#1780
bandada-infra/bandada#409
ethereum/solidity#14815
netdata/netdata#17049
ethereum/c-kzg-4844#397
ethereum/hevm#458
aptos-labs/aptos-ts-sdk#300 (Notice that in this case, the reviewers asked a small change and the PR-farmer decided it was not worth the effort)
aptos-labs/aptos-networks#61
nimiq/core-rs-albatross#2241
There are now even twitter tutorials on how to farm contributions: https://twitter.com/Abrahamchase09/status/1759101213381959960 , which has their results: https://twitter.com/toghrulmaharram/status/1759228275228905511 .
A solution could be from time to time do a PR fixing all typos, as done here: risc0/risc0#1319 , but this does not prevent future typos from happening.
What this PR does:
Add GitHub CI that runs typos so future PRs will run the
typos
check to detect typos. Also this PR fixes the detected typos.About the tool:
Multilinear, evals, arkworks, thiserror, Circom, biguint, nbits, ...
and a thousand more), since it works with a dictionary of correct words approach.