Skip to content

Commit 6dc2d38

Browse files
authored
Update: Licenses and package files (#1)
* Update: Licenses and package files * Update: CLA Url * Update: Dev Guide
1 parent a8e8053 commit 6dc2d38

8 files changed

Lines changed: 57 additions & 47 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ All contributions are welcome to this project.
66

77
Before a contribution can be merged into this project, please fill out the Contributor License Agreement (CLA) located at:
88

9-
http://opensource.box.com/cla
9+
https://developer.box.com/v2.0/docs/box-ui-elements-cla
1010

11-
To learn more about CLAs and why they are important to open source projects, please see the [Wikipedia entry](http://en.wikipedia.org/wiki/Contributor_License_Agreement).
11+
To learn more about CLAs and why they are important to the UI Element projects, please see the [Wikipedia entry](http://en.wikipedia.org/wiki/Contributor_License_Agreement).
1212

1313
## Code of Conduct
1414

@@ -20,7 +20,6 @@ This project adheres to the [Box Open Code of Conduct](http://opensource.box.com
2020
* **File an issue** - if you found a bug, want to request an enhancement, or want to implement something (bug fix or feature).
2121
* **Send a pull request** - if you want to contribute code. Please be sure to file an issue first.
2222

23-
2423
## Pull request best practices
2524

2625
We want to accept your pull requests. Please follow these steps:

LICENSE

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
SOFTWARE LICENSE AGREEMENT
33
(v.20170516)
44

5-
BOX UI ELEMENTS
5+
BOX UI ELEMENTS
66

77
This "Agreement" forms a legally binding agreement between Box (as defined in
88
Section 14) and you ("Developer") that governs Developer's right to access and
@@ -48,8 +48,8 @@ services for their respective governing terms.
4848
thereto) or to modify the SDK at any time in its sole discretion.
4949
Free/open source software components distributed in this SDK are licensed
5050
to Developer under the terms of the applicable free/open source license
51-
agreements and such free/open source software licenses can be found at
52-
https://cloud.box.com/v/preview-licenses-v1.
51+
agreements and such free/open source software licenses can be found in
52+
the THIRD_PARTY_LICENSES file in the same source directory as this file.
5353

5454
2. Use Rights & Requirements.
5555
a. Subject to Developer's compliance with the terms of this Agreement,
@@ -109,12 +109,12 @@ services for their respective governing terms.
109109
4. Contributions. Developer Contributions (as defined in the "Contributor
110110
License Agreement" (CLA)), made by the Developer pursuant to the rights
111111
granted or permitted under this Agreement, are subject to the following:
112-
a. Developer shall comply with the Contribution policy set forth here:
113-
https://github.com/box/box-content-preview/blob/master/CONTRIBUTING.md;
112+
a. Developer shall comply with the Contribution policy set forth in the
113+
CONTRIBUTING.md file in the same source directory as this file;
114114
and
115115
b. For each Contribution, Developer shall agree to the Box "Contributor
116116
License Agreement" (or "CLA") located here:
117-
https://developer.box.com/docs/ui-kits-contribution-license.
117+
https://developer.box.com/docs/box-ui-elements-cla.
118118

119119
5. Feedback. Developer may, from time to time, provide feedback to Box
120120
concerning the functionality and performance of the SDK or Box Service
@@ -345,7 +345,7 @@ services for their respective governing terms.
345345

346346

347347
Exhibit A
348-
BOX UI ELEMENTS ACCEPTABLE USE POLICY
348+
BOX UI ELEMENT ACCEPTABLE USE POLICY
349349

350350
Acceptable Use Policy. Developer shall not, and shall not use the SDKs to:
351351
a) Do anything illegal, or facilitate, promote or encourage any illegal

THIRD_PARTY_LICENSES

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
The Box UI Elements use third-party libraries which may be distributed
2-
under licenses different than the Box UI Element itself. For the
1+
The Box UI Elements use third-party libraries which may be
2+
distributed under licenses different than the Box UI Element itself. For the
33
libraries bundled at build-time, please look at package.json. The other
44
libraries are:
55

6-
1) pdf.js
6+
1. pdf.js
77
---------
88
Source code: https://github.com/mozilla/pdf.js
99
License: Apache License, Version 2.0

build/license.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
module.exports = `Box UI Element
2+
3+
Copyright 2016-present, Box, Inc.
4+
All rights reserved.
5+
6+
This source code is licensed under the Box Software License Agreement found
7+
in the LICENSE file in the root directory of this source tree. Additional
8+
third party license disclosures can be found in the THIRD_PARTY_LICENSES
9+
file in the same directory.`;

build/locales.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
const isRelease = process.env.NODE_ENV === 'production';
2-
const isJenkins = process.env.JENKINS === '1';
2+
const isCI = process.env.CI === '1';
33

4-
module.exports = isRelease && !isJenkins ? [
4+
module.exports = isRelease && !isCI ? [
55
'en-AU',
66
'en-CA',
77
'en-GB',

build/webpack.common.config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ const webpack = require('webpack');
44
const getMessages = require('./extractTranslations');
55
const version = require('../package.json').version;
66
const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin');
7+
const license = require('./license');
78

89
const DefinePlugin = webpack.DefinePlugin;
910
const BannerPlugin = webpack.BannerPlugin;
@@ -50,7 +51,7 @@ module.exports = (language) => {
5051
]
5152
},
5253
plugins: [
53-
new BannerPlugin('Box UI Elements | Copyright 2016-2017 Box | License: https://developer.box.com/docs/box-ui-kit-software-license-agreement'),
54+
new BannerPlugin(license),
5455
new OptimizeCssAssetsPlugin({
5556
cssProcessorOptions: {
5657
safe: true

build/webpack.npm.config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ const path = require('path');
22
const ExtractTextPlugin = require('extract-text-webpack-plugin');
33
const webpack = require('webpack');
44
const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin');
5+
const license = require('./license');
56

67
const BannerPlugin = webpack.BannerPlugin;
78

@@ -51,7 +52,7 @@ module.exports = {
5152
]
5253
},
5354
plugins: [
54-
new BannerPlugin('Box UI Elements | Copyright 2016-2017 Box | License: https://developer.box.com/docs/box-ui-kit-software-license-agreement'),
55+
new BannerPlugin(license),
5556
new OptimizeCssAssetsPlugin({
5657
cssProcessorOptions: {
5758
safe: true

package.json

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,36 @@
3535
"bugs": {
3636
"url": "https://github.com/box/box-ui-elements/issues"
3737
},
38+
"scripts": {
39+
"dev": "BABEL_ENV=dev NODE_ENV=dev ./node_modules/.bin/webpack --progress --colors --config build/webpack.web.config.js",
40+
"deploy": "BABEL_ENV=dev NODE_ENV=dev ./node_modules/.bin/webpack-dev-server --config build/webpack.web.config.js",
41+
"ci": "BABEL_ENV=production NODE_ENV=production CI=1 node --max_old_space_size=4096 ./node_modules/webpack/bin/webpack.js -p --progress --colors --config build/webpack.web.config.js",
42+
"prod": "BABEL_ENV=production NODE_ENV=production node --max_old_space_size=4096 ./node_modules/webpack/bin/webpack.js -p --progress --colors --config build/webpack.web.config.js",
43+
"npm": "webpack -p --progress --colors --config build/webpack.npm.config.js",
44+
"clean": "rm -rf dist && rm -rf lib && rm -rf reports/coverage && rm -rf src/i18n/json",
45+
"changelog": "./node_modules/.bin/conventional-changelog -i CHANGELOG.md -s -r 0",
46+
"prettier": "prettier-eslint --print-width 120 --tab-width 4 --single-quote --semi --write --bracket-spacing true \"src/**/*.js\"",
47+
"commitmsg": "conventional-changelog-lint -e",
48+
"prepush": "yarn run lint && yarn run flow && yarn run test",
49+
"precommit": "lint-staged",
50+
"lint": "NODE_ENV=dev ./node_modules/.bin/eslint src && ./node_modules/.bin/stylelint 'src/**/*.scss'",
51+
"test": "NODE_ENV=test ./node_modules/.bin/karma start build/karma.conf.js",
52+
"debug": "NODE_ENV=test ./node_modules/.bin/karma start build/karma.conf.js --no-single-run --auto-watch",
53+
"build": "yarn run lint && yarn run clean && yarn run dev",
54+
"build-lib": "yarn run npm && ./node_modules/.bin/cpx './src/{**/!(__tests__)/*,*}' lib && node ./build/props-to-es2015.js && BABEL_ENV=npm NODE_ENV=production ./node_modules/.bin/babel lib -d lib",
55+
"minor": "./build/release.sh -n && ./build/publish.sh"
56+
},
57+
"lint-staged": {
58+
"src/**/*.js": [
59+
"prettier-eslint --print-width 120 --tab-width 4 --single-quote --semi --write --bracket-spacing true",
60+
"git add"
61+
]
62+
},
63+
"devEngines": {
64+
"node": ">=6.x",
65+
"npm": ">=3.x",
66+
"yarn": ">=0.21.3"
67+
},
3868
"dependencies": {
3969
"classnames": "^2.2.5",
4070
"lodash.clonedeep": "^4.5.0",
@@ -139,35 +169,5 @@
139169
"peerDependencies": {
140170
"react": "^15.6.0 || ^16.0.0-alpha",
141171
"react-dom": "^15.6.0 || ^16.0.0-alpha"
142-
},
143-
"scripts": {
144-
"dev": "BABEL_ENV=dev NODE_ENV=dev ./node_modules/.bin/webpack --progress --colors --config build/webpack.web.config.js",
145-
"deploy": "BABEL_ENV=dev NODE_ENV=dev ./node_modules/.bin/webpack-dev-server --config build/webpack.web.config.js",
146-
"ci": "BABEL_ENV=production NODE_ENV=production JENKINS=1 node --max_old_space_size=4096 ./node_modules/webpack/bin/webpack.js -p --progress --colors --config build/webpack.web.config.js",
147-
"prod": "BABEL_ENV=production NODE_ENV=production node --max_old_space_size=4096 ./node_modules/webpack/bin/webpack.js -p --progress --colors --config build/webpack.web.config.js",
148-
"npm": "webpack -p --progress --colors --config build/webpack.npm.config.js",
149-
"clean": "rm -rf dist && rm -rf lib && rm -rf reports/coverage && rm -rf src/i18n/json",
150-
"changelog": "./node_modules/.bin/conventional-changelog -i CHANGELOG.md -s -r 0",
151-
"prettier": "prettier-eslint --print-width 120 --tab-width 4 --single-quote --semi --write --bracket-spacing true \"src/**/*.js\"",
152-
"commitmsg": "conventional-changelog-lint -e",
153-
"prepush": "yarn run lint && yarn run flow && yarn run test",
154-
"precommit": "lint-staged",
155-
"lint": "NODE_ENV=dev ./node_modules/.bin/eslint src && ./node_modules/.bin/stylelint 'src/**/*.scss'",
156-
"test": "NODE_ENV=test ./node_modules/.bin/karma start build/karma.conf.js",
157-
"debug": "NODE_ENV=test ./node_modules/.bin/karma start build/karma.conf.js --no-single-run --auto-watch",
158-
"build": "yarn run lint && yarn run clean && yarn run dev",
159-
"build-lib": "yarn run npm && ./node_modules/.bin/cpx './src/{**/!(__tests__)/*,*}' lib && node ./build/props-to-es2015.js && BABEL_ENV=npm NODE_ENV=production ./node_modules/.bin/babel lib -d lib",
160-
"minor": "./build/release.sh -n && ./build/publish.sh"
161-
},
162-
"lint-staged": {
163-
"src/**/*.js": [
164-
"prettier-eslint --print-width 120 --tab-width 4 --single-quote --semi --write --bracket-spacing true",
165-
"git add"
166-
]
167-
},
168-
"devEngines": {
169-
"node": ">=6.x",
170-
"npm": ">=3.x",
171-
"yarn": ">=0.21.3"
172172
}
173173
}

0 commit comments

Comments
 (0)