Skip to content

docs(README): Add credits and additional code #149

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

Merged
merged 2 commits into from
Aug 9, 2018

Conversation

spencerwilson-optimizely
Copy link
Contributor

@spencerwilson-optimizely spencerwilson-optimizely commented Aug 8, 2018

Marcelo's asked us to add "Credits" and "Additional Code" sections, where:

"Credits" is for dependencies that Optimizely distributes (i.e. any code that they download from us, for example, from a repo we set up). If there is a dependency that the customer separately installs / pulls from some non-Optimizely source, then that goes into the "Additional Code" section. The Python SDK, for example, has a few runtime dependencies like pip that the customer needs to install when setting up their application environment, but these are not distributed by Optimizely.

I take this to mean Credits is the code checked into this repo (including vendored deps, of which javascript-sdk has none), and "Additional Code" is any other code that is required for prod usage.

@coveralls
Copy link

coveralls commented Aug 8, 2018

Coverage Status

Coverage remained the same at 97.11% when pulling b63cd21 on sw/add-credits into 6a3c9a5 on master.

To regenerate this, run the following command:

```sh
npx license-checker --production --json | jq 'map_values({ licenses, publisher, repository }) | del(.[][] | nulls)'
Copy link
Contributor

Choose a reason for hiding this comment

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

Is 'license-checker' built into node or something? I don't see it in package.json.

Copy link
Contributor Author

@spencerwilson-optimizely spencerwilson-optimizely Aug 9, 2018

Choose a reason for hiding this comment

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

Not built into node. That's npx magic. I think it fetches it if necessary, storing it in some temp location.

Copy link
Contributor

Choose a reason for hiding this comment

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

That is pretty neat

Copy link
Contributor

@mikeproeng37 mikeproeng37 left a comment

Choose a reason for hiding this comment

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

Lgtm

@spencerwilson-optimizely spencerwilson-optimizely merged commit 97b4aa2 into master Aug 9, 2018
@spencerwilson-optimizely spencerwilson-optimizely deleted the sw/add-credits branch August 9, 2018 00:00
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.

4 participants