Solace Event Feeds – Community Contribution Guidelines

Training, Tips and Tricks
, ,
1

:globe_with_meridians: Solace Event Feeds – Community Contribution Guidelines

We welcome contributions to the growing catalog of Solace Event Feeds! To ensure high-quality, valuable, and reusable feed assets, please follow these guidelines before submitting your feed.

1. :white_check_mark: Uniqueness Verification

  • Check if similar feeds already exist in the community feed repository
  • If a similar feed exists, consider customizing, extending, or specializing yours to add distinct value

2. :bullseye: Feed Viability

  • Your feed must contain at least two publishable events
  • Ensure the feed reflects a realistic, usable scenario that other developers can benefit from

3. :page_facing_up: AsyncAPI Compliance

  • Feeds must be based on a valid AsyncAPI document (2.x or 3.x)

  • Ensure:

    • All events are clearly defined
    • All schemas are valid and well-structured
    • Schema format is set to application/json

4. :office_building: Domain Relevance

  • Feeds should represent meaningful business or industry domains
  • Prioritize real-world scenarios (e.g., Retail Orders, IoT Devices, Patient Monitoring, Banking Transactions)

5. :test_tube: Data Quality Standards

  • Include realistic and varied mock data generation rules

  • Use appropriate rules for each field type (e.g., names, locations, numbers, finance, IoT telemetry)

  • Ensure all generated data:

    • Matches schema constraints
    • Respects types, formats, enum values, and required fields

6. :technologist: Local Testing

  • Use the stm feed run -ui command to test your feed locally

  • Validate:

    • Messages are generated successfully for all events
    • Topics resolve correctly
    • Payloads are valid and structured as expected

7. :glowing_star: Community Value

  • Ensure your feed provides clear educational, demo, or practical value

  • Examples:

    • Teaching tools for pub/sub and request-reply patterns
    • Sample traffic for observability or schema validation
    • Domain-specific use cases for quick integration tests

8. :package: Required Metadata for Feed Submission

Please include the following details with your feed submission:

Field Description
Description A short summary explaining the purpose and value of the feed
Domain The business or industry context (e.g., Retail, Healthcare, IoT, Finance)
Tags Descriptive keywords for searchability (e.g., logistics, telemetry, fraud)
Feed Icon URL (optional) Public URL to a representative icon/image for visual identification
Contributor Your name or team name
GitHub Handle For attribution and follow-up discussions

:link: Resources

:rocket: Contribute to Solace Community Feeds!

Help developers around the world simulate real-world event-driven use cases by sharing your domain-inspired event feeds. Whether it’s for demos, testing, learning, or prototyping - your contribution can empower others to build faster, test smarter, and innovate with confidence.

Got a great event flow in mind? Package it up and share it.

Questions or suggestions? Join the conversation here - we’re here to help and collaborate!