docs: consolidate contributing guidelines and coding rules#3669
Open
TaprootFreak wants to merge 15 commits intodevelopfrom
Open
docs: consolidate contributing guidelines and coding rules#3669TaprootFreak wants to merge 15 commits intodevelopfrom
TaprootFreak wants to merge 15 commits intodevelopfrom
Conversation
Add verbose logging to trace token balance values through the pipeline: - BlockchainAdapter: log when balance changes between cache updates - BlockchainAdapter: log assets missing from cache after update - BalanceService: log when saves are skipped (updated > startDate) - BalanceService: log when balance values actually change
- Only log uncached assets when an update was actually attempted - Log balance changes for all chains, not just Ethereum - Remove redundant chainId from log message
- Only log balance changes when cache was previously populated - Add always-on BBTC (394) trace to capture Alchemy response value even when unchanged (covers the case where Alchemy returns stale data)
Comprehensive analysis of 3,609 review comments, 274 commits, and 129 review bodies to extract coding conventions and patterns.
Raw JSONL analysis data kept locally only, not needed in repo.
- Remove analysis subtitle, make it a project standard - Fix section numbering (2.2a -> 2.3, 6.4a -> 6.5) - Add missing rules: imports, trailing commas, URL construction, error message format - Clarify section comment style (// --- NAME --- //) - Clarify @DfxCron vs @Cron usage - Generalize infrastructure references
Single source of truth for all coding conventions and process rules. Resolves contradictions (JSON column pattern, simple-json vs getter/setter), fixes await-before-return nuance, adds build commands and migration workflow.
- Remove duplicate end-to-end thinking (already in PR Completeness) - Restore constraint naming algorithm table for hand-written migrations - Add explicit Avoid Eager Loading section - Add Promise.all() parallelization pattern
TaprootFreak
changed the title
- Fix @DfxCron: has built-in locking + DisabledProcess, never combine with @lock manually - Add UpdateResult<T> entity pattern (107 usages in codebase) - Add DfxLogger (not standard NestJS Logger) - Add CachedRepository<T> for reference data - Add DtoMapper class pattern - Clarify DTO inheritance is optional, not mandatory
- Fix UserData example: use actual getters (tradingLimit, isDfxUser, hasActiveUser) instead of non-existent complete()/isDataComplete() - Fix UpdateResult example: use real setPriceInvalidStatus() instead of fabricated txReceived() - Fix DtoMapper: use ClassName.entityToDto (not this.entityToDto) - Fix mapper location: not always in dto/, remove hardcoded path
- Array Methods: use real BankMapper.toDto instead of non-existent this.entityToDto instance method - .then() chains: use real PaymentLinkDtoMapper.toLinkDto and CountryDtoMapper.entitiesToDto from actual controllers - DtoMapper section: use actual PaymentLinkDtoMapper methods (toLinkDto/toLinkDtoList) instead of fabricated entityToDto
- Entity example now matches actual Recall entity in codebase
- Fix BAD example in "Don't Load Separately" to use valid TypeORM 0.3
findOne({ where: {} }) syntax so the lesson is clearly about the
pattern, not the API
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
1 participant
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.
Summary
CONTRIBUTING.mdinto a single, comprehensive document covering all coding conventions, architecture patterns, and process rulesCONTRIBUTING.mdand removes the separateCODING_RULES.mdContents
Test plan