Call-for-Code-for-Racial-Justice / Call-for-Code-for-Racial-Justice/Open-Sentencing
Open Sentencing Documentation Updates
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 76
- Forks
- 16
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
## Background
Open Sentencing has existing documentation on frontend application and backend services. We would like you try out the application and suggested improvements to the documentation.
During this cohort your team members will also be making updates to the Open Sentencing application. We would like to document these new changes in our documentation as well.
repositories:
- [ ] https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-UI
- [ ] https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-Aggregator
- [ ] https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-Model
## Tasks
Adding new documentation
- [ ] Discuss with Open Sentencing cohort members to understand changes to Open Sentencing application
- [ ] Create a new issue using the documentation templates
- [ ] label it 'documentation' 'ms-cohort-claimed' and assign the issue to yourself,
- [ ] Discuss your changes in the issue
Related Issues:
- https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-UI/issues/66
Fixing existing Documentation
- [ ] Check out the open documentation issues
- [ ] Read & follow the instructions in the Getting Started section of the readme.md to set the solution up
If any directions are unclear, outdated:
- [ ] create a new issue using the documentation template
- [ ] label it 'documentation' 'ms-cohort-claimed' and assign the issue to yourself,
- [ ] Discuss your changes in the issue
Guía de contribución
Línea de trabajo
Comienza revisando la documentación existente y la sección Getting Started del readme.md en Open-Sentencing-UI, Open-Sentencing-Aggregator y Open-Sentencing-Model. Revisa el issue #66 relacionado de Open-Sentencing-UI y consulta a los miembros de la cohorte sobre los cambios en la aplicación. Se considera completado cuando se hayan identificado las instrucciones poco claras o desactualizadas, se hayan documentado mediante la plantilla de documentación del repositorio y se hayan debatido en el issue resultante.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 20/100