Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 2.6 KB
Raw

Questions

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

Code

In an effort to have clear uniform code across a code base being developed by multiple individuals we will adopt the Airbnb style guidelines.

The above is provided primarily for reference and while it is encouraged reading, we will use eslint and the prettier formatter to automatically apply most of these rules.

Travis will automatically run eslint and prettier when a PR is made. However, it is a best practice to run both prettier and eslint locally to work out any issues before a PR is submitted.

Issues

If you encounter an issue with the product, 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 && npm test.
  3. Travis-CI will run the tests 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.