Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 1006 Bytes

File metadata and controls

24 lines (18 loc) · 1006 Bytes

Contributing to SocQ public examples

Thanks for helping improve SocQ's public developer resources.

Before opening a pull request

  1. Open an issue in SocQAPI/socq-examples for substantial changes.
  2. Keep examples small, backend-safe, and runnable with minimal dependencies.
  3. Use placeholder API keys and synthetic or clearly public sample data.
  4. Never include credentials, customer data, private account data, non-public endpoints, operational infrastructure details, or production logs.
  5. Run the repository's documented checks.

Pull requests

  • Explain what changed and why.
  • Link the relevant SocQ API documentation.
  • Add or update fixtures when a request or response shape changes.
  • Keep generated files aligned with the endpoint and template metadata.
  • Do not add unrelated refactors or dependencies.

By contributing, you agree that your contribution may be distributed under the license of the repository receiving it.