Code documentation and refactoring

moritz commented

2025-11-10 17:06:34 +01:00

Owner

Description of the implemented changes

The changes were:

Bugfixing
New Feature
Breaking Change
Refactoring

Refactor the Code according to the CODE_GUIDELINES.md

What has been changed?

Added some code documentation and split a long function.

Definition of Done

Code Quality

No new technical depths
Linting passed
Documentation is added were needed

Accessibility

New elements are properly defined with html-tags
Colour contrast follows WCAG criteria
Aria labels are added when needed
Everything is accessible by keyboard
Tab-Order is comprehensible
All interactive elements have a visible focus

Testing

Tests for new code are written
All tests pass
axe-core dev tools show no critical or major issues

## Description of the implemented changes The changes were: - [ ] Bugfixing - [ ] New Feature - [ ] Breaking Change - [x] Refactoring Refactor the Code according to the `CODE_GUIDELINES.md` ## What has been changed? Added some code documentation and split a long function. ## Definition of Done ### Code Quality - [ ] No new technical depths - [ ] Linting passed - [x] Documentation is added were needed ### Accessibility - [ ] New elements are properly defined with html-tags - [ ] Colour contrast follows WCAG criteria - [ ] Aria labels are added when needed - [ ] Everything is accessible by keyboard - [ ] Tab-Order is comprehensible - [ ] All interactive elements have a visible focus ### Testing - [ ] Tests for new code are written - [ ] All tests pass - [ ] axe-core dev tools show no critical or major issues

moritz added 8 commits 2025-11-10 17:06:36 +01:00

docs: add comprehensive project documentation and reduce redundancy

continuous-integration/drone/push Build is passing

Details

27a6f5fd50

Add CODE_GUIDELINES.md, database schema docs, and development-progress-log.md.
Refactor README.md to eliminate redundant information by linking to detailed docs.
Establish clear documentation hierarchy for better maintainability.

docs: add feature roadmap

continuous-integration/drone/push Build is passing

Details

20af015da6

docs: add @moduledoc to core membership resources 409bc7bf2f

Add comprehensive module documentation to Member, Property, PropertyType, and Email.
Improves code discoverability and enables ExDoc generation.

docs: add @moduledoc to all LiveView modules ca84633641

Add comprehensive module documentation to 12 LiveView modules covering
member, user, property, and property_type management views.

docs: add @doc to public functions in MemberLive.Index 1be55c96ff

Document LiveView callbacks (mount, handle_event, handle_info, handle_params)
with comprehensive descriptions of their purpose and supported operations.

docs: enable Credo ModuleDoc check and fix remaining modules 9c0f493840

Add @moduledoc to Secrets, LiveHelpers, AuthOverrides, and Membership domain.
Enable Credo.Check.Readability.ModuleDoc in .credo.exs.

refactor: split long sort handler into smaller functions 5748fadf52

Extract determine_new_sort/2, update_sort_components/4, and push_sort_url/3
from handle_info({:sort, ...}). Reduces function from 46 to 7 lines.

docs: add @doc to public functions in EmailSync, Validations, and Senders

continuous-integration/drone/push Build is passing

Details

8c8256c62f

Document public API functions with @doc for better tooling support:
- EmailSync Changes: sync_user_email_to_member, sync_member_email_to_user
- Validations: email_not_used_by_other_member, email_not_used_by_other_user
- Senders: send_new_user_confirmation_email, send_password_reset_email

moritz referenced this pull request

2025-11-10 17:06:49 +01:00

Regular Refactoring #122

moritz force-pushed feature/refactoring from 8c8256c62f to 7375b83167

2025-11-13 11:20:44 +01:00

Compare

moritz merged commit 87c5db020d into main

2025-11-13 11:21:32 +01:00

moritz deleted branch feature/refactoring

2025-11-13 11:21:33 +01:00

moritz referenced this pull request from a commit

2025-11-13 11:21:34 +01:00