Improve documentation for Attribution
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python, yaml
- Ambito
- cli, documentation
Direzione di ricerca
Inizia individuando la documentazione di ABCTK e l’output dell’help per il comando transform, in particolare la funzione --help--format menzionata nell’issue. Riorganizza la documentazione di alto livello nelle sezioni Attribution e file ABOUT, collocando attrib e transform sotto Attribution. Il lavoro è completato quando il contenuto YAML di transform è spiegato nella documentazione senza richiedere un’installazione di ABCTK.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Within the ABCTK documentation, we should make a distinction between the features and functions that operate on ABOUT files and those that do not require ABOUT files - namely Attribution. This means that we should organized the documentation at a high level under either Attribution or ABOUT files. The attrib and transform commands would be under Attribution and the rest under ABOUT files.
We also need a much more detailed explanation of the content of the transform yaml files - this could just be a copy of the help text from the --help--format function. We do not want to required someone to install ABCTK just to understand how the transform can work.
- Lingua principale
- Python
- Stelle
- 100
- Fork
- 48
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Nessuna 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 aboutcode-org/aboutcode-toolkit
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
-
Update PURLDB with all ABCTK releasesForse di nuovo libera @pombredanne l’ha presa 595 giorni fa e non c’è nessuna pull request aperta. ApertaImportant needs design
aboutcode-org/aboutcode-toolkit#582 · 2 commenti · 3 assegnatari ·
-
Enhance `about_resource` to reference multiple files.Forse di nuovo libera @chinyeungli l’ha presa 247 giorni fa e non c’è nessuna pull request aperta. Aperta
aboutcode-org/aboutcode-toolkit#566 · 2 commenti · 1 assegnatario ·
-
Create test file with a few hundred itemsForse di nuovo libera @DennisClark l’ha presa 1712 giorni fa e non c’è nessuna pull request aperta. Aperta
aboutcode-org/aboutcode-toolkit#491 · 2 assegnatari ·
-
Clean up / Organize codeForse di nuovo libera @sahil-MK2 l’ha presa 1731 giorni fa e non c’è nessuna pull request aperta. Aperta
aboutcode-org/aboutcode-toolkit#483 · 1 commento · 2 assegnatari ·
Tutte le issue di aboutcode-org/aboutcode-toolkit
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
vllm-project/vllm#64845 ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
dekobon/big-code-analysis#1729 ·
I maintainer di solito rispondono entro 1 giorno
-
Add `openai_safety_identifier`, the replacement for the `user` field that `openai_user` sendsAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
pydantic/pydantic-ai#12091 ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100