Improve documentation for Attribution
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 45/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- python, yaml
- Domaine
- cli, documentation
Piste de recherche
Commencez par localiser la documentation d’ABCTK et la sortie d’aide de la commande transform, en particulier la fonction --help--format mentionnée dans l’issue. Réorganisez la documentation générale en sections Attribution et fichiers ABOUT, en plaçant attrib et transform sous Attribution. Le travail est terminé lorsque le contenu YAML de transform est expliqué dans la documentation sans nécessiter d’installation d’ABCTK.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Python
- Étoiles
- 100
- Forks
- 48
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Fournit un Dockerfile ou un fichier Docker Compose
- Aucun modèle de pull request
- Aucun guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de aboutcode-org/aboutcode-toolkit
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
-
Update PURLDB with all ABCTK releasesPeut-être à nouveau libre @pombredanne l’a pris il y a 594 jours, et aucune pull request n’est ouverte. OuverteImportant needs design
aboutcode-org/aboutcode-toolkit#582 · 2 commentaires · 3 personnes assignées ·
-
Enhance `about_resource` to reference multiple files.Peut-être à nouveau libre @chinyeungli l’a pris il y a 246 jours, et aucune pull request n’est ouverte. Ouverte
aboutcode-org/aboutcode-toolkit#566 · 2 commentaires · 1 personne assignée ·
-
Create test file with a few hundred itemsPeut-être à nouveau libre @DennisClark l’a pris il y a 1711 jours, et aucune pull request n’est ouverte. Ouverte
aboutcode-org/aboutcode-toolkit#491 · 2 personnes assignées ·
-
Clean up / Organize codePeut-être à nouveau libre @sahil-MK2 l’a pris il y a 1730 jours, et aucune pull request n’est ouverte. Ouverte
aboutcode-org/aboutcode-toolkit#483 · 1 commentaire · 2 personnes assignées ·
Toutes les issues de aboutcode-org/aboutcode-toolkit
Issues similaires
-
changelog investigate
Difficulté 2/5 1-3 heures Accessibilité débutants 67/100
ramnes/notion-sdk-py#433 ·
-
docs pkg:core
Difficulté 1/5 Moins d'une heure Accessibilité débutants 84/100
pydantic/pydantic-ai#11929 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
intake/intake-esm#789 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
MemMachine/MemMachine#1877 ·
Les mainteneurs répondent en général sous 3 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
openedx/openedx-authz#579 ·
Les mainteneurs répondent en général sous 1 jour