Skip to content

The CONTRIBUTING.md does not describe how to add a new migration, run the test suite with a local database, or update sqlx offline metadata #276

Description

@Lost-Z

Summary

CONTRIBUTING.md covers basic dev setup but omits three critical workflows for contributors: (1) how to create a new database migration and update the .sqlx offline metadata, (2) how to run the Postgres-backed tests that are marked #[ignore] by default, and (3) how to update the contract_summaries trigger or other schema objects and verify the change. A contributor unfamiliar with SQLx will spend significant time discovering these workflows.

Expected Behavior

CONTRIBUTING.md should document the full workflow for schema changes and database-backed testing.

Proposed Solution

Add a Database changes section to CONTRIBUTING.md covering:

  • How to create a new migration file (sqlx migrate add <name>)
  • How to apply it locally (cargo run -p lumenqraph-indexer)
  • How to regenerate .sqlx offline metadata (cargo sqlx prepare)
  • How to run the ignored Postgres-backed tests (TEST_DATABASE_URL=... cargo test -- --ignored)

Affected Files

  • CONTRIBUTING.md

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions