Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.31 KB
Raw

Contributing to Okatana Java

Thank you for improving the SDK. Keep changes aligned with the pinned OpenAPI contract in resources/openapi.yaml.

Requirements

  • JDK 21 or later
  • Maven 3.9 or later
  • Python 3.10 or later for documentation

Development checks

mvn verify
mvn -f examples/pom.xml verify
pip install -r requirements.txt
mkdocs build --strict

Endpoint changes

When the Okatana contract changes:

  1. Replace resources/openapi.yaml with the reviewed OpenAPI file.
  2. Add or update the typed service method.
  3. Add the matching entry to EndpointCatalog.
  4. Add or update request validation only when the OpenAPI contract defines the constraint.
  5. Update the endpoint and contract documentation.
  6. Extend EndpointCoverageTest and the endpoint smoke test if needed.
  7. Add a realistic example when the new capability changes an integration workflow.

Do not invent response fields that are not defined in the OpenAPI schema. Use DynamicResource when the contract does not define a response schema.

Compatibility

Keep the public API source-compatible within a major release when practical. New response fields must not break deserialization. Do not add a default deployment host.

Security

Never commit real Okatana API keys. Tests and examples must use fake values or environment variables.