update contribution policy to mention "fake" module files for missing software installations

Ouverte
#457 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
45/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Domaine
documentation

Piste de recherche

The quoted contribution-policy paragraph about CPU-target exceptions is the text to extend; find the page in the docs source that holds it. Add a sentence describing the placeholder module files that print a useful error when no installation exists for a target, and link to #874 for context. Done when the policy names these fake module files as an allowed exception.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

We have some cases where we can't install specific modules with reasonable effort for specific CPU targets (like modules using a 2022b toolchain for zen4, cfr #874).

The contribution policy currently states:

Software that is added to EESSI should work on all [supported CPU targets](https://www.eessi.io/docs/software_layer/cpu_targets/).

Exceptions to this requirement are allowed if technical problems that can not be resolved with reasonable effort prevent the installation of the software for specific CPU targets.

This should be extended a bit to mention the "fake" module files that produce a useful error message when they're not actually providing access to an existing software installation

Langage dominant
Python
Étoiles
14
Forks
54
Merge moyen
11 h 2 min
PR mergées (30 j)
41

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de EESSI/docs

Toutes les issues de EESSI/docs

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.