Skip to content

Latest commit

 

History

History
71 lines (58 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

71 lines (58 loc) · 3.18 KB
Raw

Questions

If you have issues with the APIs or have a question about the Watson services, see Stack Overflow.

Issues

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

Pull Requests

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

  1. Fork the repository
  2. The GOPATH environment variable is used to specify directories outside of $GOROOT that contain the source for Go projects and their binaries. Example:
export GOPATH="$HOME/workspace/go-workspace"
export PATH=$PATH:$GOPATH/bin
  1. Have the following directory layout
mkdir $GOPATH/{src,bin,pkg}
  1. Clone the respository into src/github.com/watson-developer-cloud directory
  2. Use dep dependency manager. On MacOS you can install or upgrade to the latest released version of dep with Homebrew
  $ brew install dep
  $ dep ensure
  1. Check your code for lint issues
golangci-lint run
  1. Develop and test your code changes go test ./...
  2. Commit your changes:
  • 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.
  1. Push to your fork and submit a pull request to the master branch

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.

Additional Resources