Improve Documentation for Attendee List Generation Scripts.
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 1/5
- Tempo estimado
- Menos de uma hora
- Facilidade para iniciantes
- 55/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Estagnada
- Stack de tecnologia
- javascript
- Domínio
- documentation
Direção de pesquisa
Comece com util/README.md e compare suas instruções com util/create-attendee-handle-map.js e util/map-handles-to-catchup-attendees.js. Documente que esses scripts oferecem suporte a Attendee List Generation, a ordem em que devem ser executados e o diretório a partir do qual devem ser executados. Está concluído quando o README explicar claramente como gerar arquivos attendees.adoc para as sessões em summary/sessions.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
- The https://github.com/OurTechCommunity/catchup/blob/main/util/README.md file documents the usage of the two scripts https://github.com/OurTechCommunity/catchup/blob/main/util/create-attendee-handle-map.js and https://github.com/OurTechCommunity/catchup/blob/main/util/map-handles-to-catchup-attendees.js that aid in generating the
attendees.adocfile for every session insummary/sessions. - The issue is that the
util/README.mddocument isn't very explicit in mentioning- What feature the two scripts are meant for (the Attendee List Generation feature).
- The order of running the scripts.
- From where (which directory) the scripts have to be run from.
- Adding this to the documentation would make it easier to use the Attendee List Generation feature.
Cc: @tusharnankani
- Linguagem predominante
- JavaScript
- Estrelas
- 19
- Forks
- 18
- Merge médio
- 3d 6h
- PRs com merge (30d)
- 3
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 OurTechCommunity/catchup
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
OurTechCommunity/catchup#347 · 4 comentários ·
-
Clean Up Config FilesAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 55/100
OurTechCommunity/catchup#303 ·
-
Update `CONTRIBUTING.md`Abertadocumentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 38/100
OurTechCommunity/catchup#258 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 48/100
OurTechCommunity/catchup#184 · 2 comentários ·
-
CI/CD good first issue
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 55/100
OurTechCommunity/catchup#172 · 1 comentário ·
Todas as issues de OurTechCommunity/catchup
Issues semelhantes
-
bug good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 86/100
amponce/archive-movie-browser#354 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
saayam-for-all/webapp#1870 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
Imageomics/OpenCite#66 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
chr15m/twiiit.com#20 ·
-
documentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
antropos17/Aegis#629 ·
Mantenedores costumam responder em até 4 dias