HowProgrammingWorks / HowProgrammingWorks/CodeStyle
Write the JavaScript styleguide
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- JavaScript
- Estrelas
- 4
- Forks
- 2
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
For the moment our JavaScript styleguide exists implicitly and can only be inferred from reading our source code. The eslint config that we use in our projects covers the most essential parts of the code style, but a great deal of style-related things cannot be checked by linter, though the eslint config should definitely be placed in this repo too. We need to document our JavaScript code style and save these conventions both there and in Metarhia repositories.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
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 revisando o código-fonte JavaScript existente e a configuração do eslint usada nos projetos para identificar convenções que não são verificadas pelo linting. Documente as convenções em um styleguide, adicione a configuração do eslint a este repositório e garanta que as orientações resultantes possam ser salvas em repositórios Metarhia.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- eslint, javascript
- Domínio
- documentation, tooling
- 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