Skip to content
This repository has been archived by the owner on Jul 15, 2019. It is now read-only.

Commit

Permalink
Merge pull request #27 from watson-developer-cloud/updates
Browse files Browse the repository at this point in the history
 feat: Add semantic releases and IAM support
  • Loading branch information
germanattanasio authored Jul 23, 2018
2 parents ed4c80f + ea7fd4a commit c0d659e
Show file tree
Hide file tree
Showing 43 changed files with 6,257 additions and 8,958 deletions.
13 changes: 11 additions & 2 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# Environment variables
WORKSPACE_ID=<workspace-id>
CONVERSATION_USERNAME=<username>
CONVERSATION_PASSWORD=<password>

ASSISTANT_USERNAME=<username>
ASSISTANT_PASSWORD=<password>
ASSISTANT_URL=<assistant-url>

ASSISTANT_IAM_APIKEY=<assistant-apikey>

TONE_ANALYZER_USERNAME=<tone-analyzer-username>
TONE_ANALYZER_PASSWORD=<tone-analyzer-password>
TONE_ANALYZER_URL=<tone-analyzer-url>

TONE_ANALYZER_IAM_APIKEY=<assistant-apikey>


#Optional cloudant URL for login
CLOUDANT_URL=<cloudant-url>
Expand Down
4 changes: 2 additions & 2 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"consistent-return": 0
},
"globals": {
describe: true,
it: true,
"describe": true,
"it": true,
"casper": false
},
"env": {
Expand Down
11 changes: 7 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
language: node_js
node_js: 8
sudo: true
cache:
directories:
- node_modules
node_js: stable
script:
- npm run lint
- npm run codecov
Expand All @@ -16,12 +16,15 @@ env:

before_deploy: npm install -g bx-blue-green
deploy:
- provider: script
skip_cleanup: true
provider: script
script:
- bx-blue-green-travis
on:
branch: master
repo: watson-developer-cloud/food-coach
notifications:
email: false
- provider: script
skip_cleanup: true
script: npx semantic-release
on:
node: 8
65 changes: 55 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,64 @@
# Questions

If you are having difficulties running the app or have a question about the service, please ask a question on [dW Answers](https://developer.ibm.com/answers/questions/ask/?topics=watson) or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-watson).
If you are having problems using the APIs or have a question about the IBM
Watson Services, please ask a question on
[dW Answers](https://developer.ibm.com/answers/questions/ask/?topics=watson)
or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-watson).

# Issues
# Code

* Our style guide is based on [Google's](https://google.github.io/styleguide/jsguide.html), most of it is automaticaly enforced (and can be automatically applied with `npm run autofix`)
* Commits should follow the [Angular commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines). This is because our release tool uses this format for determining release versions and generating changelogs. To make this easier, we recommend using the [Commitizen CLI](https://github.com/commitizen/cz-cli) with the `cz-conventional-changelog` adapter.

If you encounter an issue with this sample app, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible somebody has encountered this issue already.
# Issues

If you encounter an issue with the Node.js library, you are welcome to submit
a [bug report](https://github.com/watson-developer-cloud/food-coach/issues).
Before that, please search for similar issues. It's possible somebody has
already encountered this issue.

# Pull Requests

If you want to contribute to the repository, here's a quick guide:
If you want to contribute to the repository, follow these steps:

1. Fork the repo.
2. Develop and test your code changes: `npm install -d && npm test`.
3. Travis-CI will run the tests for all services once your changes are merged.
4. Add a test for your changes. Only refactoring and documentation changes require no new tests.
5. Make the test pass.
6. Commit your changes.
7. Push to your fork and submit a pull request.

# Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.

## Tests

Ideally, we'd like to see both unit and innervation tests on each method.
(Unit tests do not actually connect to the Watson service, integration tests do.)

1. Fork the repo
1. Develop your code changes
1. Ensure `eslint` is happy: `npm run lint`
1. Ensure the tests pass: `npm test`
1. Commit your changes
1. Push to your fork and submit a pull request
Out of the box, `npm test` runs linting and unit tests, but skips the integration tests,
because they require credentials.
Loading

0 comments on commit c0d659e

Please sign in to comment.