RFE: Check and enforce proper spelling in CI

[Jay Faulkner]

Recently, I become aware of codespell through Nova's adoption of the tool in their codebase: https://github.com/codespell-project/codespell

Rather than using a dictionary of properly spelled words, it uses a list of known-misspellings, limiting the false positive rates significantly.

It's my belief that adding support for this tool to our tox configuration and, eventually, adding it as a lint requirement on landing changes, would lead to an overall higher quality codebase for Ironic projects.

I will push an example change to IPA showing what this would loook like. It is based on the Nova implementation of codespell as seen here: https://review.opendev.org/q/topic:%22codespell%22

At a minimum, the resulting changeset of adding a codespell target to tox and fixing misspellings caught by it, would be an improvement even if not added as required CI for landing changes.

[Jay Faulkner (jason-oldos)]

To be clear: if this gets community approval/consensus; I'd extend it to all our active repositories.

[Jay Faulkner (jason-oldos)]

There was no objection at the Jan 8 2024 meeting.

[Jay Faulkner (jason-oldos)]

Discussion in IRC was:
- Lets not vote on this in the gate yet
- Setup a new, non-voting tox target so we can see when it's broken and later decide to enable if we want.

[Iury Gregory Melo Ferreira (iurygregory)]

IPA changes are merged, marked as Fixed Released
https://review.opendev.org/c/openstack/ironic-python-agent/+/904404
https://review.opendev.org/c/openstack/ironic-python-agent/+/904405