patternfly / patternfly/patternfly-react
Update contribution guide to include guidelines for deprecated components
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 862
- Forks
- 392
- Merge moyen
- 4 j 8 h
- PR mergées (30 j)
- 9
Description
Describe the enhancement or change
What it means for a component to be deprecated is currently unclear to our consumers.
Our contribution guidelines should explain what a component being deprecated entails, including how long it will still be available and how it impacts what work will be done on it going forward.
Jira Issue: PF-123
Guide de contribution
Ouvrir le 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.
Piste de recherche
Commencez par localiser le guide de contribution du dépôt et examinez les indications existantes sur le cycle de vie des composants. Mettez à jour le guide afin de définir ce que signifie « deprecated », d’indiquer combien de temps les composants deprecated restent disponibles et d’expliquer comment la deprecation affecte les travaux futurs ; le travail est considéré comme terminé lorsque ces points sont clairs pour les consommateurs et que la revue de la documentation est validée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100