Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

79 lines (51 loc) · 3.9 KB
Raw

How to Contribute to a Solace Project

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue that addresses the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

Do you have questions about the source code?

  • Ask any question about the code or how to use Solace PubSub+ in the Solace community.

Developer Guide

Overview

The Solace PubSub+ Messaging API for Go is a wrapper around the Solace PubSub+ Messaging API for C and uses Cgo for compilation.

Repository Contents

The following are the directories that are part of the repository:

  • ./: contains the API's main entrypoints such as messaging.NewMessagingServiceBuilder
  • pkg: contains the API's interfaces, constants, configuration options and basic data structures
  • lib: contains the native C libraries used for high performance messaging
  • internal: contains the implementation for the PubSub+ API for Go
  • test: contains integration tests for the PubSub+ API for Go

Prerequisites

There are a handful of prerequisites for developing the Solace PubSub+ Messaging API for Go:

Note:

  • The integration tests are their own go module. This does not play nice with the go language server which is the default in VS Code. In particular, there is only support for a single module per workspace. The solution to this is to open the tests in their own workspace.

Testing

Any new features added to the API must have corresponding tests added ot the integration test project. See the test README for details on running the tests. Any new feature must not decrease overall test coverage.

Github Actions

The integration tests are run on every new commit via Github Actions. These tests are run on the latest Go version on Linux.

Generated Code

Certain sections of code in this project are generated from the C API's header files. For example, given the solClient.h file, the following can be run:

export SOLCLIENT_H=/path/to/repo/lib/linux/include/solclient/solClient.h
cd pkg/solace/subcode
go generate .

This will generate subcode_generated.go from the given solClient.h

The following are directories that contain code that can be generated when CCSMP updates similar to the above snippet:

  • pkg/solace/subcode
  • internal/ccsmp

Generating Documentation

Documentation should work in all cases using godoc in the module and navigating to the local webserver.

Generating Static Documentation

In addition, static documentation can be generated. To do this, first install godoc-static, and then run go run docs-templates/generate_documentation.go.