Spryker QUEST

GENERAL TECHNICAL REQUIREMENTS
Content

1. License

  • The module must be licensed under the MIT license
    • Exception: If reusing any Spryker code, the original Spryker license must be retained
  • Additionally, do not incorporate code from other sources without ensuring proper licensing and attribution

2. Packaging & Structure

  • Valid `composer.json`:
    • Specify php version range
  • Module(s) installable via Composer (no need for publishing in packagist)

3. Coding Standards & Best Practices

  • Use SprykerCommunity namespace
  • PSR-2 compliant code formatting (i.e. use vendor/spryker/code-sniffer/SprykerStrict/ruleset.xml) 
  • Follow standard Spryker module structure with appropriate application layers (see also https://docs.spryker.com/docs/dg/dev/architecture/modules-and-application-layers.html)
  • Adhere to Spryker's standard coding conventions (see also https://docs.spryker.com/docs/dg/dev/architecture/architectural-convention.html)

4. Security & Performance

  • Prevent SQL injections or XSS vulnerabilities
  • No hard-coded credentials or secrets (see also https://docs.spryker.com/docs/dg/dev/guidelines/security-guidelines.html)
  • Follow Spryker performance best practices – no N+1 queries, proper indexing for database operations (see also https://docs.spryker.com/docs/dg/dev/guidelines/performance-guidelines/architecture-performance-guidelines)
  • Input validation and sanitization

5. Documentation

  • README.md must include:
    • Essential: Module purpose, prerequisites, installation steps, basic usage examples
    • Recommended: Visuals, configuration options, dependency information
    • Optional but valued: Edge cases, limitations, advanced usage scenarios

6. Testing

See also https://docs.spryker.com/docs/dg/dev/guidelines/testing-guidelines/testing-guidelines

  • At least 5 meaningful unit tests
  • At least one integration test (module boots and basic functionality works)
  • Tests should follow Spryker's testing conventions (using proper test helpers and mocks)

About Spryker

Spryker is the leading global composable commerce platform for enterprises with sophisticated business models to enable growth, innovation, and differentiation. Designed specifically for sophisticated transactional businesses, Spryker’s easy-to-use, headless, API-first model offers a best-of-breed approach that provides businesses the flexibility to adapt, scale, and quickly go to market while facilitating faster time-to-value throughout their digital transformation journey. As a global platform leader for B2B and B2C Enterprise Marketplaces, IoT Commerce, and Unified Commerce, Spryker has empowered 150+ global enterprise customers worldwide and is trusted by brands such as ALDI, Siemens, ZF Friedrichshafen, and Ricoh. Spryker is a privately held technology company headquartered in Berlin and New York backed by world class investors such as TCV, One Peak, Project A, Cherry Ventures, and Maverick Capital. Learn more at spryker.com.

Spryker Website