Fossies - The Fresh Open Source Software Archive: Source Code Spelling Error Badges

The "Fossies" Software Archive

... Fresh Open Source Software mainly for Internet, Engineering and Science ...

Fossies codespell report badges

The Fossies source code spelling error grade assignment is more a gimmick instead of a serious rating tool. As only a very rough indicator it's not well suited to compare different projects but it may be a motivating reference point within the possibly troublesome spelling correction process.

Since nevertheless there appears to be a need for corresponding status icons here a list of all SVG badges (for different types) that would be displayed dependent on the resulting misspelling score points resp.the corresponding grade (the here shown score points are just examples):

Grade	codespell.svg		codespell.1.svg	codespell.2.svg	codespell.3.svg	codespell.4.svg
A
B
C
D
E
F

The default badge type uses only the color as status indicator, the alternative types show additionally the grade and/or the score points.

This error badge is displayed if the project is supported by Fossies but a codespell report is not available (not yet done but requestable):

This error badge is displayed if the project is not yet generally supported by Fossies and therefore a codespell report is not available:

If using the default badge type an according version-independent entry e.g. in a README.md file of a project "foobar" residing in the folder "linux/misc" could look like this

 [![Fossies codespell report](https://fossies.org/linux/misc/foobar/codespell.svg)](https://fossies.org/linux/misc/foobar/codespell.html)

resulting in this converted HTML code

 <a href="https://fossies.org/linux/misc/foobar/codespell.html"><img src="https://fossies.org/linux/misc/foobar/codespell.svg" alt="Fossies codespell report" /></a>

and this displayed badge that is linked to the according Fossies codespell report page (using as example the project "systemd"):

A hint: For development versions residing in the restricted Fossies "test"-folder the full (version-independent) tarball name must be specified, e.g.

 [![Fossies codespell report](https://fossies.org/linux/test/foobar-master.tar.gz/codespell.svg)](https://fossies.org/linux/test/foobar-master.tar.gz/codespell.html)

so resulting in this converted HTML code

 <a href="https://fossies.org/linux/test/foobar-master.tar.gz/codespell.html"><img src="https://fossies.org/linux/test/foobar-master.tar.gz/codespell.svg" alt="Fossies codespell report" /></a>

and this displayed badge that is linked to the according Fossies codespell report page (using as example the spelling corrected "systemd" GitHub master version):