Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

64 lines (47 loc) · 2.97 KB
Raw

Questions

If you are having problems using the APIs or have a question about the IBM Watson Services, please ask a question on dW Answers or Stack Overflow.

Code

  • Our style guide is based on Google's, most of it is automaticaly enforced (and can be automatically applied with npm run autofix)
  • Commits should follow the Angular 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 with the cz-conventional-changelog adapter.

Issues

If you encounter an issue with the Node.js library, you are welcome to submit a bug report. 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, 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.)

Out of the box, npm test runs linting and unit tests, but skips the integration tests, because they require credentials.