Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- MicroPython
- Redator técnico:
- Joana Nanjekye
- Nome do projeto:
- Documentar os componentes internos do MicroPython
- Duração do projeto:
- Duração padrão (três meses)
Project description
Resumo
O MicroPython é uma implementação alternativa da linguagem de programação Python. O objetivo é ser compatível com a maioria das funcionalidades do Python 3.4, mas tem um subconjunto de algumas delas, especialmente tipos e módulos de dados. O MicroPython é enxuto e eficiente para execução em microcontroladores e ambientes com recursos limitados [1]. O projeto é de código aberto e atraiu muitos usuários e colaboradores ao longo do tempo. Documentar o projeto vai estimular o crescimento de usuários e também de colaboradores de novos recursos. Contribuir para o MicroPython geralmente envolve trabalhar no tempo de execução principal, fazer a portabilidade para uma nova placa/sistema operacional ou manter uma nova biblioteca. Esta proposta se concentra na documentação das partes internas do projeto MicroPython. Os principais temas são o funcionamento interno do intérprete, a transferência da linguagem para uma nova plataforma e a criação de um novo módulo.
Detalhes do projeto
O objetivo do projeto é adicionar a documentação interna do MicroPython ao docs.micropython.org. Também podemos movê-lo para internals.micropython.org. A partir do feedback da comunidade, um dos mentores, Jim Mussared, aconselhou a mover essa documentação para uma seção “em desenvolvimento”. O objetivo é abordar os detalhes do MicroPython da perspectiva de um desenvolvedor que trabalha na implementação do próprio MicroPython. Isso levará a uma curva de contribuição suave para qualquer pessoa que queira se envolver no projeto.