doc: consider re-adding a "quickstart" document
Mantenedores costumam responder em até 2 dias
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
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Revise os exemplos de cliente e repositório em examples/ e, em seguida, rastreie como eles são vinculados a partir de README.md e docs/index.rst depois que QUICKSTART.md foi removido por #1790. Compare o material existente com o objetivo de quick-start solicitado e o critério do badge CII; o trabalho estará concluído quando a abordagem da documentação e o enquadramento ou as adições necessários estiverem claramente definidos e implementados.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Supersedes https://github.com/theupdateframework/python-tuf/issues/1006
Description of issue or feature request:
#1790 removes QUICKSTART.md because it is severely outdated. The new client and repo examples should be a good replacement to quickly get users familiar with python-tuf and are also easy to discover (e.g. via main README and main menu on RTD).
Still, there might be merit in better framing these examples or adding additional examples as a "quick start"-documentation (note: this is also a silver criteria for the cii badgeapp).
Current behavior:
- no explicit "quick start" documentation
Expected behavior:
- consider adding quick start documentation or better frame existing documentation
- Linguagem predominante
- Python
- Estrelas
- 1.7k
- Forks
- 304
- Merge médio
- 1d 2h
- PRs com merge (30d)
- 17
Preparar o ambiente
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 theupdateframework/python-tuf
-
switch to main branch?Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
theupdateframework/python-tuf#3001 ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 42/100
theupdateframework/python-tuf#2979 · 1 comentário ·
Mantenedores costumam responder em até 2 dias
-
Use Immutable ReleasesAbertaenhancement github_actions
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 45/100
theupdateframework/python-tuf#2920 · 1 comentário · 2 reações ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
theupdateframework/python-tuf#2842 · 3 comentários ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
theupdateframework/python-tuf#2836 · 7 comentários ·
Mantenedores costumam responder em até 2 dias
Todas as issues de theupdateframework/python-tuf
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
gradio-app/gradio#13895 ·
Mantenedores costumam responder em até 1 dia
-
build-error
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
spack/spack-packages#6713 ·
Mantenedores costumam responder em até 1 dia
-
Use issue templatesAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
ActivityWatch/activitywatch#1464 · 1 reação ·
Mantenedores costumam responder em até 1 dia
-
[Bug]: The ckg tool drops the return type of every decorated Python method in class search resultsAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
bytedance/trae-agent#483 ·
Mantenedores costumam responder em até 1 dia