Refactoring Frontend: Add missing JSDoc to components - Githubissues

amosproj / amos2023ss01-apache-pulsar-ui

MIT License

5 stars 2 forks source link

Refactoring Frontend: Add missing JSDoc to components #209

Open MPSebastian opened 1 year ago

MPSebastian commented 1 year ago

User story

As a developer
I want all the components to be documented with JSDoc
So that I can have a better overview of the components in the frontend

Acceptance criteria

Ad JSDoc to missing components for a better understanding

Definition of done (DoD)

Feature is done when the acceptance criteria are fullfiled
Feature is done when there are test where it is necessary and they pass
Feature is done when the linter passes
Feature is done when it is merged onto our main branch (after the code has been reviewed by at least one other person)
Feature is done when the code has been documentend or commented properly

DoD general criteria

Feature has been fully implemented
Feature has been merged into the mainline
All acceptance criteria were met
Product owner approved features
All tests are passing
Developers agreed to release