microsoft/vasim

Redo README

Open

#8 opened on Aug 30, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (7 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (12 stars)
PR merge metrics
 (PR metrics pending)

Description

Update README and design docs. We can use docs folder for seq diagrams and use https://sequencediagram.org for changing them(use txt files). We have an old version of this internally, but if we make it public it would just be misleading because too much changed

Contributor guide

Research direction
Update the README file with the current design. Create or revise sequence diagrams in the docs folder using text files and sequencediagram.org. Refer to internal old version but ensure accuracy.
Tech stack
python
Domain
None
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85