Add comprehensive developer documentation for banking application#8
Open
devin-ai-integration[bot] wants to merge 2 commits intomasterfrom
Open
Add comprehensive developer documentation for banking application#8devin-ai-integration[bot] wants to merge 2 commits intomasterfrom
devin-ai-integration[bot] wants to merge 2 commits intomasterfrom
Conversation
- Add detailed coding standards for React/TypeScript banking development - Create troubleshooting guide for common frontend development issues - Add contribution guidelines with banking-specific PR templates - Document development workflow and git branching strategy - Create environment setup guides for all environments - Add debugging guide for banking-specific frontend scenarios - Document testing procedures with 98% coverage requirements - Create onboarding guide for new developers with banking domain knowledge - All documentation focuses on banking security and compliance considerations Co-Authored-By: Arthur Poon <arthur.poon@windsurf.com>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
- Add detailed technology stack and prerequisites - Include comprehensive setup and installation instructions - Document security considerations and environment configuration - Add links to all new documentation files - Improve project structure and deployment information - Maintain 98% test coverage requirements documentation Co-Authored-By: Arthur Poon <arthur.poon@windsurf.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add comprehensive developer documentation for banking application
Summary
This PR adds extensive developer documentation covering all 9 requested areas for both the React frontend (bank-client) and NestJS backend (bank-server) repositories. The documentation focuses heavily on banking domain knowledge, security considerations, and compliance requirements.
Documentation Added (18 files total):
For Both Repositories:
The documentation emphasizes banking-grade security, financial precision using Decimal.js, double-entry bookkeeping principles, multi-currency support, and regulatory compliance (PCI DSS, GDPR, AML, KYC).
Review & Testing Checklist for Human
Recommended Test Plan:
Diagram
%%{ init : { "theme" : "default" }}%% graph TD subgraph BankClient["bank-client Repository"] ClientREADME["README.md"]:::major-edit ClientCoding["CODING_STANDARDS.md"]:::major-edit ClientTrouble["TROUBLESHOOTING.md"]:::major-edit ClientContrib["CONTRIBUTING.md"]:::major-edit ClientWorkflow["DEVELOPMENT_WORKFLOW.md"]:::major-edit ClientEnv["ENVIRONMENT_SETUP.md"]:::major-edit ClientDebug["DEBUGGING.md"]:::major-edit ClientTest["TESTING.md"]:::major-edit ClientOnboard["ONBOARDING.md"]:::major-edit ClientPRTemplate[".github/pull_request_template.md"]:::major-edit end subgraph BankServer["bank-server Repository"] ServerREADME["README.md"]:::major-edit ServerCoding["CODING_STANDARDS.md"]:::major-edit ServerTrouble["TROUBLESHOOTING.md"]:::major-edit ServerContrib["CONTRIBUTING.md"]:::major-edit ServerWorkflow["DEVELOPMENT_WORKFLOW.md"]:::major-edit ServerEnv["ENVIRONMENT_SETUP.md"]:::major-edit ServerDebug["DEBUGGING.md"]:::major-edit ServerTest["TESTING.md"]:::major-edit ServerOnboard["ONBOARDING.md"]:::major-edit ServerPRTemplate[".github/pull_request_template.md"]:::major-edit end subgraph ExistingCode["Existing Codebase"] PackageJSON["package.json"]:::context ESLintConfig[".eslintrc.js"]:::context JestConfig["jest.config.js"]:::context EnvExample[".env.example"]:::context end ExistingCode --> BankClient ExistingCode --> BankServer subgraph Legend L1["Major Edit"]:::major-edit L2["Minor Edit"]:::minor-edit L3["Context/No Edit"]:::context end classDef major-edit fill:#90EE90 classDef minor-edit fill:#87CEEB classDef context fill:#FFFFFFNotes
Banking Domain Focus: All documentation emphasizes security-first development, financial precision using Decimal.js, double-entry bookkeeping principles, multi-currency support, and regulatory compliance requirements.
Coverage Requirements: Frontend maintains 98% test coverage threshold, backend requires 90% coverage with specific emphasis on transaction processing and security features.
Security Considerations: Documentation includes comprehensive security guidelines covering JWT authentication, input validation, audit logging, and banking-specific vulnerability prevention.
Link to Devin run: https://app.devin.ai/sessions/944d8aeae5c74aaab67f1ac1b92917ea
Requested by: @akkp-windsurf