canonical/open-documentation-academy

Snapcraft: create how-to documentation for review-tools

Ouverte

#6 ouverte le 25 janv. 2024

Voir sur GitHub
 (6 commentaires) (0 réaction) (1 personne assignée)Python (99 forks)auto 404
help wantedhow-tonewsize 5

Métriques du dépôt

Stars
 (119 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Write a how-to guide on using review-tools to check a snap is consistent and secure.

Background

The review-tool command can be used to test whether a freshly built snap will pass Store tests permitting the snap to be published. The Store runs reviews tools whenever a new snap is uploaded. The following is a common command, for example:

review-tools.snap-review cameractrls_0.5.6-0-gd8136d1_amd64.snap

This how-to should cover how to install the review-tools snap, how its most important functions are accessed, and how some of the most common problems could be mitigated.

Prerequisites

You will need some experience building snaps.

See also Contribute to our documentation.

Guide contributeur

Direction de recherche
Recherchez le snap review tools en l'installant et en exécutant la commande snap review sur un exemple de snap. Explorez sa sortie d'aide et les modèles d'utilisation courants. Examinez la structure et le style de la documentation Snapcraft existante pour aligner le nouveau guide pratique. Identifiez les problèmes courants liés aux révisions de snap et comment les résoudre.
Stack technique
shell
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitSnapcraft
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75