Define markdown convention/formatting rules
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- markdown
- Domínio
- ci-cd, documentation
Direção de pesquisa
Comece com CONTRIBUTING.md e um arquivo Markdown representativo do repositório. Compare mdformat, markdownlint, dprint com seu plugin de Markdown e Prettier conforme proposto; em seguida, documente as convenções selecionadas e integre a verificação escolhida ao CI para que futuras saídas Markdown sejam verificadas automaticamente.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
It would be good to define our standards/expectations for markdown formatting somewhere consistently.
A good place for this would be CONTRIBUTING.md, but other places could work too.
In addition to introducing documentation on how markdown should be written in the repo, we should probably try and
implement some tooling that enables machines to check our output for us:
- https://github.com/hukkin/mdformat
- https://github.com/DavidAnson/markdownlint
- https://dprint.dev/overview/ w/ https://github.com/dprint/dprint-plugin-markdown
- Prettier (listed last because it's intentionally hard to configure)
I think a good PR that resolves this issue would have a comparison of the output of these tools on one of our files, along with integration of the tool into CI so that we can catch issues going forward.
- Linguagem predominante
- Rust
- Estrelas
- 138
- Forks
- 89
- Merge médio
- 10h 38min
- PRs com merge (30d)
- 2
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de bytecodealliance/component-docs
-
Dificuldade 2/5 Meio dia Facilidade para iniciantes 72/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
bytecodealliance/component-docs#294 · 1 comentário ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 68/100
bytecodealliance/component-docs#376 · 1 comentário ·
-
Fix Python TutorialAbertabug lang/python
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
bytecodealliance/component-docs#348 · 2 comentários ·
Todas as issues de bytecodealliance/component-docs
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Mantenedores costumam responder em até 3 dias
-
state:triage-needed
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
Automattic/harper#4503 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
tobi/walgit#84 · 1 comentário ·
Mantenedores costumam responder em até 2 dias