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.

Sign up for GitHub

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

Jump to bottom

Replace whitelist/blacklist terminology #650

Merged
merged 2 commits into from
Jan 6, 2020
Merged

Replace whitelist/blacklist terminology #650

merged 2 commits into from
Jan 6, 2020

Conversation

grantbdev
Copy link
Contributor

@grantbdev grantbdev commented Dec 12, 2019 •
edited

The goal of this pull request is to replace whitelist/blacklist terminology in the user-facing functionality and in the codebase. It is a good opportunity to clarify the commands since the old terms are not inherently descriptive. rubocop/rubocop#6464 has links to the original motivation and many changes to other gems that have been replacing those words.

This PR introduces breaking changes. The existing subcommands are completely replaced and the output and the expected input for dependency decision files will be different. Users with an existing dependency decisions file will need to find and replace all instances of blacklist with restrict and whitelist with permit.

@cf-gitbot
Copy link
Collaborator

We have created an issue in Pivotal Tracker to manage this. Unfortunately, the Pivotal Tracker project is private so you may be unable to view the contents of the story.

The labels on this github issue will be updated when the story is started.

@kdykeman
Copy link
Contributor

kdykeman commented Dec 13, 2019 •
edited

Hi @grantbdev, I found a similar issue related to rails documentation. In that case it looks like they went with the terms permitted and restricted. Is it ok if we go with those terms?

Also, I know it would be a breaking change for some, but what do you think about doing a find/replace on the existing terms rather than supporting two alternatives (one of which might be deemed offensive)?

@grantbdev
Copy link
Contributor Author

Hi @grantbdev, I found a similar issue related to rails documentation. In that case it looks like they went with the terms permitted and restricted. Is it ok if we go with those terms?

@kdykeman I'm a fan of using permit and permitted in many cases. However, do you think in this usage it may be confusing: license_finder permitted add MIT? Using permitted by itself as a noun sounds weird to me. permitted_licenses and restricted_licenses is very clear, but longer. Just some things to consider so we can get it right.

Also, I know it would be a breaking change for some, but what do you think about doing a find/replace on the existing terms rather than supporting two alternatives (one of which might be deemed offensive)?

That sounds good to me. Do you want me to update this PR to change everything at once as a breaking change for a v6?

@kdykeman
Copy link
Contributor

@kdykeman I'm a fan of using permit and permitted in many cases. However, do you think in this usage it may be confusing: license_finder permitted add MIT? Using permitted by itself as a noun sounds weird to me. permitted_licenses and restricted_licenses is very clear, but longer. Just some things to consider so we can get it right.

@grantbdev I agree it's better to be more verbose to help with clarity. permitted_licenses and restricted_licenses sounds like the better way to go.

That sounds good to me. Do you want me to update this PR to change everything at once as a breaking change for a v6?

Yes please... that would be super helpful!

@grantbdev grantbdev changed the title Provide public interface alternatives to whitelist/blacklist terminology Replace whitelist/blacklist terminology Dec 19, 2019
@grantbdev
Copy link
Contributor Author

@kdykeman Thank you for your guidance. PR updated!

@grantbdev
Replace whitelist terminology
a40b22f 
Replace whitelist terminology with the concept of permitted licenses.
The new terminology aims to be more intuitive and
descriptive of the functionality provided to users.

This is a breaking change and users with an existing
dependency decisions file will need to find and replace all instances
of `whitelist` with `permit`.

https://developers.google.com/style/word-list#blacklist
rubocop/rubocop#6464
@grantbdev
Replace blacklist terminology
0f78ebf 
Replace blacklist terminology with the concept of restricted licenses
and packages. The new terminology aims to be more intuitive and
descriptive of the functionality provided to users.

This is a breaking change and users with an existing
dependency decisions file will need to find and replace all instances
of `blacklist` with `restrict`.

https://developers.google.com/style/word-list#blacklist
rubocop/rubocop#6464
@xtreme-shane-lattanzio xtreme-shane-lattanzio merged commit df903c6 into pivotal:master Jan 6, 2020
@grantbdev grantbdev deleted the gb/list-terminology-option branch January 6, 2020 17:03
@pivotal-issuemaster
Copy link

@grantbdev Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

@pivotal-issuemaster
Copy link

@grantbdev Thank you for signing the Contributor License Agreement!

@flavorjones flavorjones mentioned this pull request Jun 2, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
accepted
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@grantbdev @cf-gitbot @kdykeman @pivotal-issuemaster @xtreme-shane-lattanzio