Skip to content
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

Terminology changes: replacing controversial terms from our codebase #4101

Merged
merged 14 commits into from
Jan 24, 2022

Conversation

antgamdia
Copy link
Contributor

@antgamdia antgamdia commented Jan 17, 2022

Description of the change

This (long, sorry!) PR is performing minor renames in some of the terminology used across the project.
Some automatic linters have been used to detect the issues, but in most cases, the replacement is manual (ie. please expect some unnoticed remaining items).

Perhaps we might want to add those linters as part of our Ci process; perhaps not as a blocker step (due to the false positives), but as a report we can check from time to time.
In case anyone is interested they are:

  • Misspell
  • vale with these style rules:
    • inclusivity (from here), Joblint, proselint, write-good

Benefits

We'll be one step ahead in the conformance with OSS good practices.

Possible drawbacks

N/A

Applicable issues

Additional information

DO NOT MERGE

until the master branch has been renamed to main, otherwise the CI will fail.

Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
@antgamdia antgamdia marked this pull request as draft January 17, 2022 19:10
@antgamdia antgamdia changed the title Terminology Terminology changes: replacing controversial terms from our codebase Jan 17, 2022
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
@absoludity
Copy link
Contributor

Description of the change

This (long, sorry!) PR

Personally, I have no problem with long PRs for automated or manual mechanical changes. They don't require thought. If it's not automated, but is a boring mechanical change, it just requires scanning usually. Not hard to keep context for thousands of lines :)

is performing minor renames in some of the terminology used across the project. Some automatic linters have been used to detect the issues, but in most cases, the replacement is manual (ie. please expect some unnoticed remaining items).

Right, so it's not automated, but manual mechanical changes.

Perhaps we might want to add those linters as part of our Ci process; perhaps not as a blocker step (due to the false positives), but as a report we can check from time to time.

+1 to add the linters as part of CI, assuming false positives can be noted for ignoring by the linter?

In case anyone is interested they are:

* [Misspell](https://github.com/client9/misspell/tree/master)

* [vale](https://github.com/errata-ai/vale) with these style rules:
  
  * `inclusivity` (from [here](https://github.com/vmware-tanzu/community-engagement/blob/main/INCLUSIVE_TERMINOLOGY.md)), `Joblint`, `proselint`, ` write-good`

Benefits

We'll be one step ahead in the conformance with OSS good practices.

Possible drawbacks

N/A

Applicable issues

* rel [Inclusive terminology - Rename master branch in Kubeapps #4075](https://github.com/kubeapps/kubeapps/issues/4075)

Additional information

DO NOT MERGE

until the master branch has been renamed to main, otherwise the CI will fail.

Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>

Conflicts:
	go.sum
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
@antgamdia antgamdia marked this pull request as ready for review January 24, 2022 13:45
@antgamdia
Copy link
Contributor Author

antgamdia commented Jan 24, 2022

+1 to add the linters as part of CI, assuming false positives can be noted for ignoring by the linter?

It is something I'd like to work on when defining the new Kubeapps website. In fact, the linters I mentioned are from my local branch where I performed some changes for the new webpage.
But, of course, adding those linters is something we really want. Moreover, some of them already Github actions we just need to install and configure.

After the +1 from Pepe, I'm renaming master to main and merging this PR.
I'm ready to perform a follow-up/rollback PR if something goes wrong.

@antgamdia antgamdia merged commit b836f88 into vmware-tanzu:master Jan 24, 2022
@antgamdia antgamdia deleted the terminology branch January 24, 2022 17:02
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.

None yet

3 participants