misfix.org is a service to check source-code ( git, tar.gz, ..) for most common misspellings.
- funciton --> function
- dont --> don't
- .. plus thousands more.
why should I care ? It's compiling !
- you invested a lot of effort to write some nice software
- there are tests, documentation
- you do manual and automated tests
- ... but the comments in the source are just for fun ?
anyone who will work with the code in future, might read them; And starting to wonder what this funny word, rather to fix that bug. ( see weather vs. wether )
sounds great; me too !
there will be multiple ways how you can benefit from this.
- regular checks (e.g. once a week) over your source. (or delta)
- triggering a test per-commit. ( might require some configuration on your side - github-pr-triggers, commit-mailinglist-signup, ... )
.. and then ? ( future options )
- sending a .patch to the (commit-) author / QA-team / ...
- an automatic pull-request to your GitHub
- painting some nice batches
you got patch!
- if the patch don't apply 100% - by the nature of spelling-fixes this is ok.
- you can rework/ignore/.. the patch - up to your needs.
the bad things
- overall, this is not very intelligent; it's more like a big sed script
- so, there might be false-positives...
do I need now some new servers?
- nop, it's all on our backend.
- you register the project - we check, we inform you, we keep the system up and running, the dicts in a healthy state.
- security is important.
- when we talk about open-source.. well, what-to-hack.
- we track as less information as needed. sensitive data will be kept in secured back-office.
- you will receive patch-proposals; double-check them is up to you.
shut up and take my money !
- currently, we handle open source stuff, like GitHub.com, Savannah.gnu.org, ... ( incomplete list, just to name a few )
- keep calm, it's just spelling-fixes, most likely in comments.
there might be an non-free option in future.
- if there is need that you want such a tool for you private sources, lets talk.
- if you want to have realtime (as fast as possible..) results.
- manual validity checks, manual edits
- running tests to the outcome ( e.g. before/after compiling, if you have no seperate CI )
talk to my lawyer
- if your project can affor a lawyer (who will tell you how bad the world is..) - nop.
- the BOT is stupid and can't sign a CLA