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

Architecture.md documentation file #4

Open
clarkeben opened this issue Oct 9, 2021 · 0 comments
Open

Architecture.md documentation file #4

clarkeben opened this issue Oct 9, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation hacktoberfest Hacktoberfest feature or bug help wanted Extra attention is needed

Comments

@clarkeben
Copy link
Collaborator

clarkeben commented Oct 9, 2021

Is your feature request related to a problem? Please describe.
Documentation is required to provide contributors with additional details surrounding the app. An architecture.md file is required to have all the necessary details.

You can find the Architecture file here - https://github.com/Shubham0812/HabitTracker_UI/blob/main/docs/Architecture.md

It has half of the basic information, you have to complete the rest.

Describe the solution you'd like
Here are some highlights worth covering:

  • MVVM design pattern
  • Any other logic worth highlighting

The file should be used as a reference point to new developers joining the project.

Describe alternatives you've considered
The contributor will need to go through the current Xcode file and take note of the structure. Where possible please use screenshots or diagrams. The contributor should understand how MVVM works, but also be able to explain it.

@clarkeben clarkeben added documentation Improvements or additions to documentation help wanted Extra attention is needed hacktoberfest Hacktoberfest feature or bug labels Oct 9, 2021
@clarkeben clarkeben added this to To do in Habit Tracker To Do List via automation Oct 9, 2021
@clarkeben clarkeben moved this from To do to Done in Habit Tracker To Do List Oct 19, 2021
@clarkeben clarkeben moved this from Done to To do in Habit Tracker To Do List Oct 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest Hacktoberfest feature or bug help wanted Extra attention is needed
Development

No branches or pull requests

2 participants