microsoft/vasim

Redo README

Aberta

#8 aberto em 30 de ago. de 2024

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Python (7 forks)auto 404
documentationhelp wanted

Métricas do repositório

Stars
 (12 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Atualize o arquivo README com o design atual. Crie ou revise diagramas de sequência na pasta docs usando arquivos de texto e sequencediagram.org. Consulte a versão antiga interna, mas garanta a precisão.
Pilha de tecnologia
python
Domain
None
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85