Skip to content

Add development setup instructions to README #75

@SeanTAllen

Description

@SeanTAllen

The README documents how to install and use the library, but there's no documentation for contributors on how to build from source and run tests. Key information that should be documented:

  • Makefile targets (make, make unit-tests, make integration-tests, make build-examples)
  • Integration tests require a running PostgreSQL 14.5 instance (make start-pg-container / make stop-pg-container)
  • SSL build flag requirement
  • Environment variables for test configuration (POSTGRES_HOST, POSTGRES_PORT, POSTGRES_USERNAME, POSTGRES_PASSWORD, POSTGRES_DATABASE)

A "Development" section in the README would be the natural place — the CONTRIBUTING.md is org-wide boilerplate and shouldn't hold project-specific instructions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions