Skip to content

Conversation

@javydekoning
Copy link
Contributor

@javydekoning javydekoning commented Dec 16, 2022

Why?

  • Introducing CSpell to reduce the number of spelling mistakes in our code.
  • Also a first effort to reduce non inclusive language.
  • Standardize on en_US instead (we are mixing en_US with en_UK).

Describe why you are proposing these changes

Issue #, if available:

For example, to avoid typo's such as:
#567

What?

Description of changes:

  • Added a custom dictionary under /linters
  • Added (and removed from repo) blocked words: 'whitelist' and 'blacklist'
  • Fixed spelling mistakes such as: 'TERIMIATION', 'MANGEMENT', 'DOESNT'.
  • Enabled the linter in our megalinter config.
  • Changed to en_US. For example: 'Standardised -> Standardized', 'Initialisation -> Initialization'

What is NOT covered.

Changing 'Master' to 'Management'. This is still used at many places in this repository and changing this will have an impact on current installs. Best to tackle that in the next major version of ADF.


By submitting this pull request, I confirm that you can use, modify, copy, and
redistribute this contribution, under the terms of your choice.

Copy link
Collaborator

@sbkok sbkok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this so quickly!
This well help a lot with reviewing code and ensuring typos don't accidentally end up in logical resource names as you mentioned.

I also agree on the inclusive wording. I worked on a branch a while ago to change the master account references into management account (in the code mainly), but I parked that until we can start working on the next major version.

StewartW
StewartW previously approved these changes Dec 16, 2022
Copy link
Contributor

@StewartW StewartW left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Great addition. Ironic spelling mistake in the PR title is intentional yeah ;)

@javydekoning javydekoning changed the title Instroduce CSpell linter Introduce CSpell linter Dec 16, 2022
@StewartW StewartW merged commit 7d28e99 into awslabs:master Dec 20, 2022
@javydekoning javydekoning deleted the cspell branch December 20, 2022 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants