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.

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

[Backend] Add basic documentation to controllers, models and service classes #21

Open
smessie opened this issue Nov 30, 2022 · 0 comments
Assignees
Labels
diff: easy 0-1h documentation Improvements or additions to documentation prio: low Changes are cosmetic, not hindering, or hindering but not urgent

Comments

@smessie
Copy link
Member

smessie commented Nov 30, 2022

The backend lacks basic documentation on the functionality of its components, which makes it harder for new collaborators (such as myself) to get familiar with the code base. While studying the project structure, I will try to add simple documentation in locations where I think it could be useful for future reference.

@smessie smessie added documentation Improvements or additions to documentation diff: easy 0-1h prio: low Changes are cosmetic, not hindering, or hindering but not urgent labels Nov 30, 2022
@smessie smessie moved this to Todo in Studieplekken Nov 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
diff: easy 0-1h documentation Improvements or additions to documentation prio: low Changes are cosmetic, not hindering, or hindering but not urgent
Projects
Status: Todo
Development

No branches or pull requests

2 participants