SZUT/casino
SZUT/casino
Archived
3
1
Fork 0
Code Issues Pull requests 2 Releases 162 Packages 2 Wiki Activity Actions

chore: Remove old Anhang and add some code to the docs #317

Merged
jank merged 2 commits from docs/code into main 2025-06-12 15:33:54 +00:00
Conversation 4 Commits 2 Files changed 10 +489 -53
jank commented 2025-06-12 13:30:12 +00:00
Owner
Copy link
No description provided.
chore: Remove old Anhang and add some code to the docs
All checks were successful
Build docs / build-docs (pull_request) Successful in 29s
Details
Label PRs based on size / Check PR size (pull_request) Successful in 27s
Details
CI / Get Changed Files (pull_request) Successful in 34s
Details
CI / Backend Tests (pull_request) Has been skipped
Details
CI / eslint (pull_request) Has been skipped
Details
Pull Request Labeler / labeler (pull_request_target) Successful in 4s
Details
CI / Checkstyle Main (pull_request) Has been skipped
Details
CI / oxlint (pull_request) Has been skipped
Details
CI / Docker frontend validation (pull_request) Has been skipped
Details
CI / prettier (pull_request) Has been skipped
Details
CI / Docker backend validation (pull_request) Has been skipped
Details
CI / test-build (pull_request) Has been skipped
Details
CI / Playwright (pull_request) Has been skipped
Details
Claude PR Review / claude-code (pull_request) Successful in 1m41s
Details
0e9e729fdf
forgejo-actions commented 2025-06-12 13:30:45 +00:00
Copy link

👮‍♀️⚠️ This is a friendly reminder that the diff size of this PR is bigger than 200 lines we aim for. Please consider splitting this PR into more digestible pieces!

👮‍♀️⚠️ This is a friendly reminder that the diff size of this PR is bigger than 200 lines we aim for. Please consider splitting this PR into more digestible pieces!
Claude commented 2025-06-12 13:31:49 +00:00
Collaborator
Copy link

Code Review Feedback

Issues Found:

projektdokumentation/Listings/CoinflipComponent.ts:

  • Line 7 in Anhang.tex: Incorrect language specification for TypeScript file - should be or
  • Lines 140-143: Inconsistent property access pattern with both and suggests API response uncertainty
  • Missing proper null checks in method

projektdokumentation/Listings/CoinflipController.java:

  • Line 14: Unused import should be removed
  • Line 31: Missing user existence validation before game logic

projektdokumentation/Listings/UserEntity.java:

  • Lines 89-90: method uses fragile string replacement that could break if username/email contain replacement patterns

projektdokumentation/Listings/application.properties:

  • Security concern: Hardcoded sensitive values (Stripe keys, JWT secrets) shouldn't appear in documentation examples
  • Configuration inconsistency between development and production values

projektdokumentation/Abkuerzungen.tex:

  • Line 38: Removed API abbreviation may still be referenced elsewhere in document

projektdokumentation/Inhalt/Coinflip.tex:

  • Line 42: Sentence with multiple consecutive references reduces readability

Positive aspects:

  • Good modernization of documentation content
  • Proper demonstration of multi-layer architecture
  • Relevant code examples for the casino platform

Please address the language specification and security concerns before merging.

## Code Review Feedback ### Issues Found: **projektdokumentation/Listings/CoinflipComponent.ts:** - Line 7 in Anhang.tex: Incorrect language specification for TypeScript file - should be or - Lines 140-143: Inconsistent property access pattern with both and suggests API response uncertainty - Missing proper null checks in method **projektdokumentation/Listings/CoinflipController.java:** - Line 14: Unused import should be removed - Line 31: Missing user existence validation before game logic **projektdokumentation/Listings/UserEntity.java:** - Lines 89-90: method uses fragile string replacement that could break if username/email contain replacement patterns **projektdokumentation/Listings/application.properties:** - Security concern: Hardcoded sensitive values (Stripe keys, JWT secrets) shouldn't appear in documentation examples - Configuration inconsistency between development and production values **projektdokumentation/Abkuerzungen.tex:** - Line 38: Removed API abbreviation may still be referenced elsewhere in document **projektdokumentation/Inhalt/Coinflip.tex:** - Line 42: Sentence with multiple consecutive references reduces readability ### Positive aspects: - Good modernization of documentation content - Proper demonstration of multi-layer architecture - Relevant code examples for the casino platform Please address the language specification and security concerns before merging.
Merge main
All checks were successful
CI / Get Changed Files (pull_request) Successful in 9s
Details
CI / eslint (pull_request) Has been skipped
Details
Pull Request Labeler / labeler (pull_request_target) Successful in 4s
Details
CI / Backend Tests (pull_request) Has been skipped
Details
CI / oxlint (pull_request) Has been skipped
Details
CI / Checkstyle Main (pull_request) Has been skipped
Details
CI / prettier (pull_request) Has been skipped
Details
CI / Docker frontend validation (pull_request) Has been skipped
Details
CI / test-build (pull_request) Has been skipped
Details
CI / Docker backend validation (pull_request) Has been skipped
Details
Label PRs based on size / Check PR size (pull_request) Successful in 16s
Details
CI / Playwright (pull_request) Has been skipped
Details
Build docs / build-docs (pull_request) Successful in 26s
Details
Claude PR Review / claude-code (pull_request) Successful in 1m21s
Details
d916fe4942
Claude commented 2025-06-12 13:37:42 +00:00
Collaborator
Copy link

Code Review

The documentation update looks good overall - nice work removing outdated content and adding relevant code examples. However, there are a few minor issues to address:

Issues:

  1. projektdokumentation/Listings/CoinflipComponent.ts:18+ - Mixed language comments (German comments with English code) should be consistent
  2. projektdokumentation/Listings/CoinflipComponent.ts:247 - Missing newline at end of file
  3. projektdokumentation/Listings/CoinflipComponent.ts:142 - The frontend workaround for backend API inconsistency suggests the backend should be fixed instead
  4. projektdokumentation/Listings/application.properties:53 - Missing newline at end of file
  5. projektdokumentation/Listings/application.properties:11,34,46 - Consider using placeholder values for API keys in documentation instead of real test keys
  6. projektdokumentation/Anhang.tex:23 - Language attribute should be 'typescript' or 'javascript' instead of 'C' for the TypeScript listing

Positive aspects:

  • Great job removing outdated content
  • Comprehensive architectural examples
  • Good cross-referencing between sections
  • Clear documentation structure

The changes effectively improve the documentation quality. Please address the minor issues above.

## Code Review The documentation update looks good overall - nice work removing outdated content and adding relevant code examples. However, there are a few minor issues to address: **Issues:** 1. **projektdokumentation/Listings/CoinflipComponent.ts:18+** - Mixed language comments (German comments with English code) should be consistent 2. **projektdokumentation/Listings/CoinflipComponent.ts:247** - Missing newline at end of file 3. **projektdokumentation/Listings/CoinflipComponent.ts:142** - The frontend workaround for backend API inconsistency suggests the backend should be fixed instead 4. **projektdokumentation/Listings/application.properties:53** - Missing newline at end of file 5. **projektdokumentation/Listings/application.properties:11,34,46** - Consider using placeholder values for API keys in documentation instead of real test keys 6. **projektdokumentation/Anhang.tex:23** - Language attribute should be 'typescript' or 'javascript' instead of 'C' for the TypeScript listing **Positive aspects:** - Great job removing outdated content - Comprehensive architectural examples - Good cross-referencing between sections - Clear documentation structure The changes effectively improve the documentation quality. Please address the minor issues above.
csimonis approved these changes 2025-06-12 13:39:15 +00:00
jank merged commit 7221422d3b into main 2025-06-12 15:33:54 +00:00
jank deleted branch docs/code 2025-06-12 15:33:55 +00:00
Commenting is not possible because the repository is archived.
Reviewers
No reviewers
csimonis
Labels
Clear labels   
Compat/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Feature

New functionality

  
Kind/Security

This is security issue

  
Kind/Testing

Issue or pull request related to testing

  
Priority
Critical
The priority is critical

  
Priority
High
The priority is high

  
Priority
Low
The priority is low

  
Priority
Medium
The priority is medium

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

  
backend

   
ci

   
docs

   
frontend
  
lgtm
blocked

  
lgtm
done

  
lgtm
need 1

  
size
huge

  
size
large

  
size
medium

  
size
small

No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
backend
ci
docs
frontend
lgtm
blocked
lgtm
done
lgtm
need 1
size
huge
size
large
size
medium
size
small
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
4 participants
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: SZUT/casino#317
No description provided.
Delete branch "docs/code"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?