Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add code documentation #158

Open
1 task
PhlppKrmr opened this issue Jun 14, 2023 · 1 comment
Open
1 task

Add code documentation #158

PhlppKrmr opened this issue Jun 14, 2023 · 1 comment
Assignees
@lifesbest23
Labels
documentation Improvements or additions to documentation refactoring Refactoring of old features

Comments

@PhlppKrmr
Copy link
Contributor

User story

  1. As a developer
  2. I want / need sufficient code documentation
  3. So that every developer is familiar with the code base

Acceptance criteria

  • Devs mainly focusing on backend should document the frontend and vice versa

Linked Issues

  • Blocked by:
  • Related to:
  • Implements

Additional information

  • We know asking backend devs to document the frotnend and vice versa introduces extra effort, but we want everybody to know the whole codebase and be confident in all parts of the codebase
  • For the frontend we can maybe use JSDoc

Definition of done (DoD)

DoD general criteria

  • Feature has been fully implemented
  • All acceptance criteria were met
  • Product owner approved features
  • All tests are passing
  • Pull request to "develop" branch is merged & closed
  • Bill of materials is updated with new dependencies
@PhlppKrmr PhlppKrmr added documentation Improvements or additions to documentation refactoring Refactoring of old features labels Jun 14, 2023
@PhlppKrmr PhlppKrmr moved this to Product Backlog in amos2023ss04-feature-board Jun 14, 2023
@jandegen jandegen added this to the Sprint 10 milestone Jun 19, 2023
@PhlppKrmr PhlppKrmr moved this from Product Backlog to Sprint Backlog in amos2023ss04-feature-board Jun 21, 2023
@lifesbest23 lifesbest23 self-assigned this Jun 27, 2023
@lifesbest23 lifesbest23 moved this from Sprint Backlog to In Progress in amos2023ss04-feature-board Jun 27, 2023
@lifesbest23
Copy link
Contributor

Started writing code documentation for the Explorer.

@jandegen jandegen moved this from In Progress to Product Backlog in amos2023ss04-feature-board Jun 28, 2023
@PhlppKrmr PhlppKrmr removed this from the Sprint 10 milestone Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lifesbest23 lifesbest23

Labels
documentation Improvements or additions to documentation refactoring Refactoring of old features
Projects
amos2023ss04-feature-board
Status: Product Backlog
Milestone
No milestone
Development

No branches or pull requests
3 participants
@PhlppKrmr @lifesbest23 @jandegen