Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

79 lines (60 loc) · 3.54 KB
Raw

Issues

If you encounter an issue with the 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 go-sdk-core project uses Go modules for dependency management, so do NOT set the GOPATH environment variable to include your local go-sdk-core project directory.

  3. Clone the respository into a local directory.

  4. Install the golangci-lint tool:

    curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(go env GOPATH)/bin v1.21.0
  • Note: As of this writing, the 1.21.0 version of golangci-lint is being used by this project. Please check the curl command found in the .travis.yml file to see the version of this tool that is currently being used at the time you are planning to commit changes. This will ensure that you are using the same version of the linter as the Travis build automation, which will ensure that you are using the same set of linter checks that the automated build uses.

  1. Make your code changes as needed. Be sure to add new tests for any new or modified functionality.

  2. Test your changes:

    go test ./...

  3. Check your code for lint issues

    golangci-lint run

  4. Commit your changes:

  • Commit messages should follow the Angular commit message guidelines. This is because this project uses semantic-release for build release automation, and semantic-release uses this commit message style 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 your commit(s) 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