Pythonia

Pythonie

Bienvenue à Pythonia - Le référentiel de collection Python Functions! Il s'agit d'un référentiel public où n'importe qui peut contribuer ses fonctions Python. Qu'il s'agisse d'un script unique ou d'un projet plus complexe divisé en plusieurs fichiers, vos contributions sont les bienvenues.

Table des matières

• À propos
• Comment contribuer
• Lignes directrices
• Structure de dossier
• Licence
• Contribuer

À propos

Ce référentiel est une collection de diverses fonctions et scripts Python. L'objectif est de créer un ensemble diversifié de fonctions utiles qui peuvent aider d'autres développeurs et passionnés. Les contributions peuvent aller de simples fonctions utilitaires aux projets plus complexes.

Comment contribuer

Contribuer à ce référentiel est simple. Suivez les étapes ci-dessous pour commencer:

1. Fourk le référentiel : cliquez sur le bouton Fork dans le coin supérieur droit de cette page.
2. Clone votre fourche : clonez votre référentiel à fourche vers votre machine locale.

   git clone https://github.com/ < your-username > /python-functions-collection.git

3. ** Créez une nouvelle branche: créez une nouvelle branche pour vos contributions.

   git checkout -b my-new-function

4. Ajoutez votre fonction: ajoutez votre (s) fonction (s) Python au dossier approprié ou créez-en un nouveau.
5. Commissez vos modifications: engagez vos modifications avec un message de validation significatif.

   git add .
   git commit -m " Add new function for XYZ "

6. Poussez à votre fourche: poussez vos modifications à votre référentiel à fourche.

   git push origin my-new-function

7. Créez une demande de traction: accédez au référentiel d'origine et cliquez sur le New Pull Request .
8. Mettez également à jour le fichier "exigences.txt" en fonction de votre projet.

Lignes directrices

Pour vous assurer que le référentiel reste organisé et utile, veuillez suivre ces directives lors de la contribution:

• Organiser le code dans les dossiers: si votre contribution se compose de plusieurs fichiers ou pièces, placez-les dans un dossier. Nommez le dossier de manière descriptive.
• Contributions de fichiers uniques: si votre contribution est un seul fichier Python, placez-le directement dans la section appropriée.
• Conventions de dénomination: utilisez des noms descriptifs pour les fichiers et les dossiers. Évitez les noms génériques comme script.py ou function.py.
• Documentation: incluez des commentaires et des docstrings dans votre code pour expliquer ses fonctionnalités.
• Test: si possible, incluez un petit script de test ou un exemple montrant comment utiliser votre fonction.
• Informations sur la licence: assurez-vous que vos contributions sont compatibles avec la licence du référentiel (voir ci-dessous).

Structure de dossier

Organisez le référentiel de manière significative. Voici un exemple de structure:

  Pytonia/
  |
  | -- single_file_functions/
  |   | -- example_function.py
  |
  | -- multi_part_functions/
  |   | -- project_name/
  |       | -- part1.py
  |       | -- part2.py
  |       | -- README.md
  |
  | -- README.md

• single_file_functions: pour les contributions de fichiers python uniques.
• MULTI_PART_FONCTIONS: pour des projets avec plusieurs pièces / fichiers. Chaque projet doit avoir son propre dossier.
• Readme.md: ce fichier.

Licence

Ce projet est autorisé sous la licence du MIT. En contribuant, vous acceptez que vos contributions seront autorisées en vertu de la licence du MIT.

Contribuer

Nous accueillons les contributions de tous. Voici comment vous pouvez aider:

• Soumettez des rapports de bogues et des demandes de fonctionnalités: utilisez le tracker de problème pour signaler les bogues ou suggérer des fonctionnalités.
• Examiner les demandes de traction: examiner les demandes de traction des autres contributeurs.
• Améliorer la documentation: aider à améliorer cette lecture, ajouter des commentaires et améliorer la documentation du code.