anitab-org / anitab-org/mentorship-backend

docs: Add diagrams to Wiki to help visualise Backend system

Open
#530 10 comments 1 reaction 0 assignees View on GitHub
Category: Documentation/Training Status: Available
Dominant language
Python
Stars
200
Forks
449
PR merge metrics
No merged PRs in 30d

Description

## Description
As a new contributor of the open source project,
I need to be able to see a visual overview of the existing system that I am going to work on,
so that I can quickly gain an understanding of the system current state.

## Mocks
Screen Shot 2020-04-06 at 9 44 55 pm

Screen Shot 2020-04-06 at 9 46 04 pm

[draw.io file](https://drive.google.com/file/d/1ELZ4Ym7tCeJXILrcubEFmE717Ns8Zkua/view?usp=sharing)

## Acceptance Criteria
### Update [Required]

- [ ] a diagram with relations between classes, entities, different layers of the application.
- [ ] simplified class diagram showing attributes, methods and/or specific information.
- [ ] Wiki documentation to include the above diagrams

## Definition of Done
- [ ] All of the required items are completed.
- [ ] Approval by 1 mentor.

## Estimation

1 hr

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.