Contribuer
Le projet grandit avec ce que les utilisateurs de TopSolid decouvrent dans leur travail : une recette qui fait gagner une heure, un piege de l'API, une correction, un essai sur une autre version de TopSolid. Pas besoin d'ecrire du C# pour contribuer.
| Vous avez... | Faites ceci | TopSolid requis |
|---|---|---|
| un bug ou un plantage | Signaler un bug, ou Signaler un bug dans le menu de l'icone : version, systeme et etat de connexion sont remplis pour vous | non |
| une tache que vous voudriez en une recette | Demander une recette | non |
un script qui a marche dans topsolid_execute_script | Le proposer comme recette, ou ouvrir une pull request | oui, pour le tester |
| trouve un piege de l'API (unite, appel refuse, boite de dialogue qui bloque...) | Partager un piege d'API : il rejoint les skills des agents | non |
| fait tourner le serveur sur une version ou une configuration non listee | Signaler la compatibilite | oui |
Les questions et les retours d'usage vont dans les Discussions. Les taches pour commencer portent le label good first issue.
Les regles
- Uniquement du materiel public : l'aide publique de TopSolid (help.topsolid.com), le SDK Automation installe avec TopSolid et vos propres essais. Jamais de documentation non publique, de code ou de donnees de votre employeur, de fichiers, noms de pieces ou chemins d'affaires clientes.
- Signez vos commits (DCO) :
git commit -sajouteSigned-off-by: Votre Nom <vous@exemple.com>et certifie que vous avez le droit de soumettre la modification sous licence MIT. Une verification echoue sur les pull requests dont les commits ne sont pas signes. - Ni secret ni chemin personnel : la CI lance
scripts/privacy-scan.pysur chaque pull request. - Le code est en anglais (noms et descriptions des recettes, identifiants, commentaires) ; ce site est en francais, les pages en anglais sont bienvenues.
Ajouter une recette, en bref
- Mettre au point le script en direct avec
topsolid_compilepuistopsolid_execute_script. - L'ajouter dans
server/src/Tools/RecipeTool.csavec le bon mode :Rlecture,RWmodification du modele (transaction et sauvegarde automatiques),RNappels PDM ou document seulement (hors transaction),RDecriture de fichiers. - Ajouter son nom dans
server/data/recipe-list.txt, a la meme place. python scripts/check-recipes.py, puis regenererserver/data/recipes.mdavecserver/scripts/gen-recipes-catalog.py.- Dans la pull request, dire sur quelle version de TopSolid, sur quel document, et ce que la recette a rendu.
Le detail (installation, regles du C# 5, tests, skills, documentation) est dans le guide de contribution, en anglais.
Ce qui vient
Le parcours de contribution s'ameliore par etapes : une recette par fichier, un kit de test public, des skills relus par la CI. Voir la roadmap.