Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (38 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 1.92 KB
Raw

Issues

Report bugs or feature requests to our github issue tracker. Before that, please search for similar issues as it's possible that somebody has already run into it. If you want to contribute to the WVA Chat Widget, please be sure to open an issue beforehand!

Running Locally

  1. Clone this repository

        git clone https://github.com/watson-virtual-agents/chat-widget

  2. Open /index.html in your favorite text editor and set the values for the botID, XIBMClientID and XIBMClientSecret parameters:

        <script>
        window.IBMChat.init({
            el: 'ibm_el',
            baseURL: 'https://api.ibm.com/virtualagent/run/api/v1/',
            botID: '',              // replace with Bot ID
            XIBMClientID: '',       // replace with Client ID
            XIBMClientSecret: ''    // replace with Client Secret
        });
    </script>

  3. Save your changes.

Important: Keep the values of the IBMClientID and IBMClientSecret as private as possible. And certainly don't make your private keys part of your PR!.

  1. Run the following commands using Node 4.2.1 or higher:

    npm install
npm run watch

  2. Navigate to http://localhost:3100.

Questions

For questions please refer to StackOverflow under tag watson-virtual-agent or DeveloperWorks Answers.

Pull Requests

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

  1. Fork the repo.
  2. Install locally: npm install.
  3. Develop your code changes.
  4. Test your changes: npm run test.
  5. Follow the instructions at ./DCO.txt.
  6. Commit your changes.
  7. Push to your fork and submit a pull request.