local-it/mitgliederverwaltung
2
3
Fork 0
Code Issues 51 Pull requests 13 Projects 1 Releases Packages 1 Activity Actions

Docs, Code Guidelines and Progress Log #193

Merged
moritz merged 2 commits from feature/guidelines_docs into main 2025-11-13 11:17:31 +01:00
Conversation 0 Commits 2 Files changed 6 +5289 -16
moritz commented 2025-11-10 14:36:06 +01:00
Owner
Copy link

Description of the implemented changes

The changes were:

  • Bugfixing
  • New Feature
  • Breaking Change
  • Refactoring

Establish clear documentation hierarchy for better maintainability.

What has been changed?

  • Add CODE_GUIDELINES.md, database schema docs, and development-progress-log.md
  • Refactor README.md to eliminate redundant information by linking to detailed docs

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 - [ ] Refactoring Establish clear documentation hierarchy for better maintainability. ## What has been changed? - Add CODE_GUIDELINES.md, database schema docs, and development-progress-log.md - Refactor README.md to eliminate redundant information by linking to detailed docs ## 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 self-assigned this 2025-11-10 14:36:06 +01:00
moritz added 1 commit 2025-11-10 14:36:07 +01:00
docs: add comprehensive project documentation and reduce redundancy
All checks were successful
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.
moritz added this to the Sprint 8 - 23.10 - 20.11 project 2025-11-10 14:36:08 +01:00
moritz added 1 commit 2025-11-10 15:50:01 +01:00
docs: add feature roadmap
All checks were successful
continuous-integration/drone/push Build is passing
Details
06a4293a2c
moritz force-pushed feature/guidelines_docs from 06a4293a2c to 20af015da6 2025-11-10 15:57:09 +01:00 Compare
moritz force-pushed feature/guidelines_docs from 20af015da6 to 92e3e50d49 2025-11-13 11:16:02 +01:00 Compare
moritz merged commit a4ed2498e7 into main 2025-11-13 11:17:31 +01:00
moritz deleted branch feature/guidelines_docs 2025-11-13 11:17:31 +01:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug

Something is not working

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
help wanted

Need some help

  
high priority

   
invalid

Something is wrong

  
L

5 h

  
low priority

   
M

3 h

  
medium priority

   
needs refinement

   
question

More information is needed

  
S

1 h

  
UX research

   
wontfix

This won't be fixed

No labels
bug
duplicate
enhancement
help wanted
high priority
invalid
L
low priority
M
medium priority
needs refinement
question
S
UX research
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Sprint 8 - 23.10 - 20.11
Assignees
Clear assignees
No assignees
moritz
1 participant
Notifications
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: local-it/mitgliederverwaltung#193
No description provided.
Delete branch "feature/guidelines_docs"

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?