Skip to content

Commit

Permalink
update script paths and add contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
mlabieniec committed Dec 6, 2017
1 parent ef841e1 commit c464471
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 16 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Bugs

Bug reports and feature suggestions are welcome. When filing a bug, try to include as much information as you can. Details like these are incredibly useful:

* A reproducible test case or series of steps
* The date/commit of the code you're running
* Any modifications you've made relevant to the bug
* Anything unusual about your environment or deployment

# Pull Requests

Pull requests are welcome!

You should open an issue to discuss your pull request, unless it's a trivial change. It's best to ensure that your proposed change would be accepted so that you don't waste your own time.

Pull requests should generally be opened against **master**.

## Tests

Please ensure that your change still passes unit tests, and ideally integration/UI tests. It's OK if you're still working on tests at the time that you submit, but be prepared to be asked about them.

## Code Style

Generally, match the style of the surrounding code. We ship an EditorConfig file for indentation and TSLint configuration for TypeScript code. Please ensure your changes don't wildly deviate from those rules. You can run `npm run lint` to identify and automatically fix most style issues.

## Licensing

oss-attribution-builder is [Apache 2.0](LICENSE)-licensed. Contributions you submit will be released under that license.

We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
"version": "1.0.0",
"description": "",
"scripts": {
"test": "lerna run -- test",
"build": "lerna run -- build",
"clean": "lerna run -- clean",
"format": "lerna run -- format",
"lint": "lerna run -- lint"
"test": "node_modules/.bin/lerna run -- test",
"build": "node_modules/.bin/lerna run -- build",
"clean": "node_modules/.bin/lerna run -- clean",
"format": "node_modules/.bin/lerna run -- format",
"lint": "node_modules/.bin/lerna run -- lint"
},
"repository": {
"type": "git",
Expand Down
6 changes: 3 additions & 3 deletions packages/aws-amplify-react-native/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
"main": "dist/index.js",
"scripts": {
"test": "jest --coverage",
"build": "npm run clean && babel src --presets babel-preset-react --out-dir dist --copy-files",
"generate-docs": "rimraf docs && jsdoc -c ./jsDoc.config.json --readme ../../media/api_reference_home.md ./src -r -d ./docs",
"clean": "rimraf dist"
"build": "npm run clean && node_modules/.bin/babel src --presets babel-preset-react --out-dir dist --copy-files",
"generate-docs": "node_modules/.bin/rimraf docs && node_modules/.bin/jsdoc -c ./jsDoc.config.json --readme ../../media/api_reference_home.md ./src -r -d ./docs",
"clean": "node_modules/.bin/rimraf dist"
},
"devDependencies": {
"babel-cli": "^6.26.0",
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-amplify-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"description": "AWS Amplify is a JavaScript library for Frontend and mobile developers building cloud-enabled applications.",
"main": "dist/index.js",
"scripts": {
"test": "jest --coverage",
"build": "babel src --presets babel-preset-react --out-dir dist --copy-files",
"test": "node_modules/.bin/jest --coverage",
"build": "node_modules/.bin/babel src --presets babel-preset-react --out-dir dist --copy-files",
"build-with-test": "npm test && npm run build"
},
"devDependencies": {
Expand Down
12 changes: 6 additions & 6 deletions packages/aws-amplify/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"description": "AWS Amplify is a JavaScript library for Frontend and mobile developers building cloud-enabled applications.",
"main": "./lib/index.js",
"scripts": {
"test": "jest --coverage",
"build-with-test": "npm run clean && npm test && tsc && webpack",
"build": "npm run clean && tsc && webpack",
"clean": "rimraf lib lib-esm dist",
"format": "tsfmt --useTsfmt tsfmt.json -r src/**/*.ts",
"lint": "tslint 'src/Common/**/*.ts",
"test": "node_modules/.bin/jest --coverage",
"build-with-test": "npm run clean && npm test && node_modules/.bin/tsc && node_modules/.bin/webpack",
"build": "npm run clean && node_modules/.bin/tsc && node_modules/.bin/webpack",
"clean": "node_modules/.bin/rimraf lib lib-esm dist",
"format": "node_modules/.bin/tsfmt --useTsfmt tsfmt.json -r src/**/*.ts",
"lint": "node_modules/.bin/tslint src/Common/**/*.ts",
"generate-docs-local": "typedoc --out docs src",
"generate-docs-root": "typedoc --out ../../docs src"
},
Expand Down

0 comments on commit c464471

Please sign in to comment.