Deliverables - VittorioDeMarzi/hero-beans GitHub Wiki

  • Each team should manage their project in a shared GitHub repository—either by creating a new organization or by adding collaborators, as decided within the team. The following deliverables must be clearly documented and accessible via the repository's README, issues, pull requests, or wiki.

  • Understanding any domain-specific requirements or constraints

  • Documentation of the tech stack and system architecture

  • Description of the Git workflow and PR review process

  • CI/CD configuration files and deployment scripts

  • API documentation (e.g., Swagger/OpenAPI)

  • Feature specifications and corresponding test scenarios

  • Performance test results based on large dataset insertion

  • Index configuration with rationale and performance analysis

  • Description of your zero-downtime deployment strategy

  • TPS (Transactions Per Second) configuration and justification

  • Infrastructure improvement proposal (e.g., SPOF mitigation, scaling strategy)

  • Team retrospective document

  • Service planning documentation, including:

    • What kind of product or service the platform is selling
    • Key assumptions about users, use cases, or the target market
    • Any special business logic, edge cases, or compliance considerations (e.g., age verification for alcohol sales, refund policies, etc.)