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

Expanding our guidelines #10021

Open
PeterShaggyNoble opened this issue Dec 4, 2023 · 1 comment
Open

Expanding our guidelines #10021

PeterShaggyNoble opened this issue Dec 4, 2023 · 1 comment
Labels
meta Issues or pull requests regarding the project or repository itself package Pull requests or issues that affect the NPM package

Comments

@PeterShaggyNoble
Copy link
Member

In light of some of the icons we have had to remove recently and with more to come, I would like to propose that we expand the current guidelines entry in our JSON to turn it into an object and allow the inclusion of trademark (usage) guidelines where applicable.

From:

"guidelines": "[URL]"

To:

"guidelines": {
    "branding": "[URL]",
    "trademark": "[URL]"
}

In cases where there are 2 separate documents for brand and trademark guidelines, the former will often only cover how the branding should be used with the latter covering the contexts of when it can and can't be used. Both entries should be optional to allow for cases where either one document or the other doesn't exist and cases where one document covers everything (for which we should use the branding entry), and, of course, the guidelines entry itself should still remain optional. We would then serve up the trademark guidelines everywhere we currently serve up the brand guidelines (e.g., on our website).

In addition, as a measure to reduce the file size of our JSON, I propose that when the source URL matches the guidelines.branding URL then source should be omitted and that that should be enforced by our linter. This would then necessitate a change to how the source URL is retrieved, such as:

if(icon.source)
    return icon.source;
else
    return icon.guidelines.branding;

Or:

if(!icon.source)
    icon.source=icon.guidelines.branding;

I haven't had a chance since being back to completely refamiliarise myself with how everything works, nor familiarise myself with changes that were implemented while I was gone, so I'm not sure if either proposal constitutes a breaking change Issues or pull requests that include a breaking change and scheduled for the next major release .

@PeterShaggyNoble PeterShaggyNoble added meta Issues or pull requests regarding the project or repository itself package Pull requests or issues that affect the NPM package labels Dec 4, 2023
@PeterShaggyNoble PeterShaggyNoble pinned this issue Dec 8, 2023
@adamrusted
Copy link
Member

I think we'd be better to keep 'source' regardless, and only include the additional metadata if they contribute something the source doesn't. Theat way we keep the core metadata of title, hex, source consistent while allowing for additional info where necessary. Can still run a check against source and guidelines.branding to ensure they're different as part of our lint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Issues or pull requests regarding the project or repository itself package Pull requests or issues that affect the NPM package
Projects
None yet
Development

No branches or pull requests

2 participants