automated docs review
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- rust
- Ambito
- ci-cd, documentation, testing
Direzione di ricerca
Non sono indicati file, test o punti di ingresso. Inizia esaminando la documentazione e la configurazione CI del repository, quindi determina come identificare ed eseguire gli esempi Rust. Il lavoro sarà completato quando sarà stato concordato un approccio che verifichi in modo affidabile gli esempi della documentazione, con eventuali raccomandazioni opzionali per il PR esplicitamente delimitate.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is your feature request related to a problem? Please describe.
It would be great if there was a CI job that could read the docs, run the examples, and make sure everything was still correct as we merge new PRs. As time passes and features get added/removed, docs (especially those that are example-oriented) can drift away from usefulness.
Describe the solution you'd like
There are a lot of possible solutions to this problem. We could use a simple parser to extract the rust examples and run them, but that could get convoluted quickly. We could also use AI. I don't know which is the best yet, but I'm just writing this quickly so a discussion can start.
The goal (first & foremost) ensure accuracy of code examples in docs.
If we can add AI code reviews and recommendations related to the PR (i.e. to remind the PR's dev to update the docs) that would be an excellent addition.
- Lingua principale
- Rust
- Stelle
- 144
- Fork
- 58
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di flashbots/contender
-
engine_newPayload filesApertaenhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 45/100
-
server: generate reportsApertaenhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
server: export DB from sessionForse di nuovo libera @zeroXbrock l’ha presa 203 giorni fa e non c’è nessuna pull request aperta. Apertaenhancement help wanted question
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 62/100
-
bug
Difficoltà 3/5 1-2 giorni Idoneità per principianti 52/100
Tutte le issue di flashbots/contender
Issue simili
-
priority middle
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
KATO-Hiro/AtCoderClans#13029 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
RustCrypto/formats#2544 ·
I maintainer di solito rispondono entro 1 giorno
-
bug ui
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
userFRM/egui-charts#3363 ·
I maintainer di solito rispondono entro 1 giorno
-
ada documentation mobile report
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 86/100
physicsdolphin/nv-uefi-unlocker#254 · 2 reazioni ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
kindraywind/rustnarok-client#1382 ·
I maintainer di solito rispondono entro 1 giorno