Skip to content

Latest commit

 

History

History
91 lines (57 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

91 lines (57 loc) · 2.9 KB
Raw

Contributing

System Requirements

go 1.19+ is recommended.

Setup workspace

Run the following command to set up the go workspace:

make workspace-init

To sync go.work with the current modules, run:

make workspace-update

Adding a module

The project provides makefile targets for creating hooks and providers. To contribute a new hook or provider, fork this repository and create a new go module, it will then be discoverable by make workspace-init and make workspace-update.

To automatically create and set up a new provider directory, use the following command (requires jq):

make MODULE_NAME=NAME new-provider

To automatically create and set up a new hook directory, use the following command (requires jq):

make MODULE_NAME=NAME new-hook

Note - jq documentation

Versioning

The release version of the newly added module(hook/provider) is controlled by .release-please-manifest.json. You can control the versioning of your module by adding an entry with desired initial version(ex:"provider/acme":"0.0.1"). Otherwise, default versioning will start from 1.0.0.

Documentation

Any published modules must have documentation in their root directory, explaining the basic purpose of the module as well as installation and usage instructions. Instructions for how to develop a module should also be included (required system dependencies, instructions for testing locally, etc).

Testing

Any published modules must have reasonable test coverage.

To run tests in all existing go modules, use the command:

make test

It is recommended to include end-to-end (e2e) tests in your provider when possible. If you have dependency services for your e2e tests, make sure to add them as service in the build pipeline. Also, make sure to include them in the makefile for easy use by contributors.

To start e2e test helpers use the command:

make e2e-start-helpers

Then, you can run all tests, including e2e tests using the command:

make e2e

Once tests are complete, you can remove e2e test helpers using the command:

make e2e-remove-helpers

Releases

This repo uses Release Please to release packages. Release Please sets up a running PR that tracks all changes for the library components, and maintains the versions according to conventional commits, generated when PRs are merged. Merging the Release Please PR will create a GitHub release with updated library versions.

Dependencies

The GO-SDK should be a peer dependency of your module.