NativeScript / NativeScript/nativescript-cli
Document all hooks and how to use them
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- JavaScript
- Estrelas
- 1.1k
- Forks
- 204
- Merge médio
- 1d 9h
- PRs com merge (30d)
- 8
Descrição
Did you verify this is a real problem by searching Stack Overflow and the other open issues in this repo?
Yes, the current hooks documentation does not describe all hooks and use-cases. Also the link in https://github.com/NativeScript/nativescript-cli/blob/master/README.md#extending-the-cli is broken.
Tell us about the problem
We need to document all hooks for CLI and how the plugins and users can get benefit of them.
Tasks:
- Fix the link in https://github.com/NativeScript/nativescript-cli/blob/master/README.md#extending-the-cli
- Document all hooks and when they are executed.
- Describe how to use the hooks and add examples.
- Add tests that verify the examples in the previous step work correctly and will not be broken in future release.
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.
Direção de pesquisa
Comece pela seção “Extending the CLI” do README da CLI e pelo link quebrado nela. Faça um inventário dos hooks e de seus pontos de execução e, em seguida, documente seu uso e exemplos para plugins e usuários. Adicione testes que exercitem os exemplos documentados e confirmem que eles continuam funcionando.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- javascript
- Domínio
- cli, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100