Call-for-Code-for-Racial-Justice / Call-for-Code-for-Racial-Justice/Open-Sentencing

Open Sentencing Documentation Updates

Aperta
#56 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub
ms-cohort-claimed stale
Lingua principale
Nessun dato sulla lingua
Stelle
76
Fork
16
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## 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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando la documentazione esistente e la sezione Getting Started del readme.md in Open-Sentencing-UI, Open-Sentencing-Aggregator e Open-Sentencing-Model. Controlla l’issue #66 correlata di Open-Sentencing-UI e confrontati con i membri della coorte sulle modifiche all’applicazione. Il lavoro è considerato completato quando le istruzioni poco chiare o obsolete sono state identificate, documentate tramite il modello di documentazione del repository e discusse nell’issue risultante.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
20/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.