Skip to content

Latest commit

 

History

History
477 lines (306 loc) · 21.2 KB

File metadata and controls

477 lines (306 loc) · 21.2 KB

Important

We are looking for translators for this project.
Any kind of help would be greatly appreciated.
Please see issue #23 if you would like to help!

Métriques de développement dans le README avec les drapeaux de fonctionnalités ajoutés 🎌

Project Preview

Project Preview

📌✨Awesome README Stats


Star Badge

Êtes-vous un très tôt 🐤 ou un nocturne 🦉?
À quel moment de la journée êtes-vous le plus productif?
Quelles sont les langues dans lesquelles vous codez?
Découvrez-le dans votre README de profil!

Signaler un bug Demander une fonctionnalité

Travail préparatoire

  1. Vous devez mettre à jour le fichier markdown (.md) avec 2 commentaires. Vous pouvez vous référer ici pour le mettre à jour.
  2. Vous aurez besoin d'une clé API WakaTime. Vous pouvez l'obtenir depuis les paramètres du compte WakaTime
    • Vous pouvez vous référer ici, si vous êtes nouveau sur WakaTime.
  3. Vous aurez besoin d'un jeton API GitHub avec les portées repo et user depuis ici si vous exécutez l'action pour obtenir les métriques de commit.
    • Vous pouvez utiliser cet exemple pour vous y retrouver.

Note

Enabling the repo scope seems DANGEROUS,
but this GitHub Action only accesses your commit timestamps and the number of lines of code added or deleted in repositories that you contributed to.

  1. Vous devez enregistrer la clé API WakaTime et le jeton d'accès personnel (PAT) GitHub dans les secrets du dépôt. Vous pouvez les trouver dans les Paramètres de votre dépôt.
    Assurez-vous de les enregistrer comme suit :
    • Clé API WakaTime comme WAKATIME_API_KEY=<votre clé API WakaTime>
    • Jeton d'accès personnel (PAT) GitHub comme GH_TOKEN=<votre jeton d'accès GitHub>
  2. Vous pouvez activer et désactiver les drapeaux de fonctionnalité selon vos besoins.

Cette action GitHub peut être configurée pour s'exécuter à tout moment souhaité à l'aide de cron. Consultez Crontab.guru et celui-ci pour générer des expressions cron.

Mettez à jour votre Readme

Ajoutez un commentaire à votre README.md comme ceci :

<!--START_SECTION:waka-->
<!--END_SECTION:waka-->

waka peut être remplacé par toute chaîne spécifiée dans le drapeau SECTION_NAME selon la section des drapeaux disponibles.

Ces lignes seront nos points d'entrée pour les métriques de développement.

Nouveau sur WakaTime

WakaTime vous donne une idée du temps réellement passé à coder. Cela vous aide à améliorer votre productivité et votre avantage concurrentiel.

Répertoire de profil

Vous devrez obtenir un GitHub Access Token avec une portée repo et user et le sauvegarder dans les Secrets du Répertoire GH_TOKEN = <Your GitHub Access Token>

Voici un exemple de fichier de workflow pour l'exécuter :

name: Waka Readme

on:
  schedule:
    # Runs at 12am IST
    - cron: '30 18 * * *'
  workflow_dispatch:
jobs:
  update-readme:
    name: Update Readme with Metrics
    runs-on: ubuntu-latest
    steps:
      - uses: anmol098/waka-readme-stats@master
        with:
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
          GH_TOKEN: ${{ secrets.GH_TOKEN }}
  • Maintenant, vous pouvez commiter et attendre qu'il s'exécute automatiquement, ou vous pouvez également le déclencher pour voir le résultat maintenant. Allez simplement dans Actions dans votre dépôt, sélectionnez votre workflow Profile Readme Development Stats et cliquez sur Run workflow. Maintenant, attendez une minute ou deux et vous verrez vos modifications.

Extras

Si vous souhaitez ajouter d'autres informations à vos statistiques, vous pouvez ajouter plusieurs FLAGS dans votre fichier de workflow. Par défaut, tous les drapeaux sont activés (sauf le drapeau du nombre de lignes de code en raison de l'opération lourde effectuée)

- uses: anmol098/waka-readme-stats@master
  with:
      WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
      GH_TOKEN: ${{ secrets.GH_TOKEN }}
      SHOW_OS: "False"
      SHOW_PROJECTS: "False"

Drapeaux Disponibles


LOCALE Ce drapeau peut être utilisé pour afficher les statistiques dans votre langue. La valeur par défaut est l'anglais. Le code de localisation abrégé doit être transmis dans la variable du drapeau. Un exemple du résultat final peut être trouvé ici

Le drapeau SECTION_NAME peut être défini à n'importe quelle chaîne, et sera le nom de la section à remplacer dans le README.

Le drapeau COMMIT_BY_ME peut être défini à True pour commiter le code en utilisant votre nom et votre adresse e-mail.

Le drapeau COMMIT_MESSAGE peut être défini pour le message de commit. La valeur par défaut est "Updated with Dev Metrics"

Le drapeau COMMIT_USERNAME peut être défini comme un nom d'utilisateur pour commiter le code. La valeur par défaut est "readme-bot".

Le drapeau COMMIT_EMAIL peut être défini à une adresse e-mail pour commiter le code. La valeur par défaut est "41898282+github-actions[bot]@users.noreply.github.com".

Le drapeau SHOW_UPDATED_DATE peut être défini à True pour afficher la date de mise à jour à la fin du paragraphe.

Le drapeau UPDATED_DATE_FORMAT peut être défini pour mettre la date de mise à jour dans un format. La valeur par défaut est "%d/%m/%Y %H:%M:%S".

Le drapeau SHOW_LINES_OF_CODE peut être défini à True pour afficher le nombre de lignes de code écrites jusqu'à présent.

Lines of Code

Le drapeau SHOW_TOTAL_CODE_TIME peut être défini à False pour cacher Code Time.

Code Time

Le drapeau SHOW_PROFILE_VIEWS peut être défini à False pour cacher Profile Views

Profile Views

Le drapeau SHOW_COMMIT peut être défini à False pour cacher les statistiques de commit.

Je suis un débutant 🐤

🌞 Morning    95 commits     ███████░░░░░░░░░░░░░░░░░░   30.55% 
🌆 Daytime    78 commits     ██████░░░░░░░░░░░░░░░░░░░   25.08% 
🌃 Evening    112 commits    █████████░░░░░░░░░░░░░░░░   36.01% 
🌙 Night      26 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   8.36%

Le drapeau SHOW_DAYS_OF_WEEK peut être défini à False pour cacher les commits effectués les différents jours de la semaine.

📅 Je suis le plus productif les dimanches

Monday       50 commits     ███░░░░░░░░░░░░░░░░░░░░░░   13.19% 
Tuesday      85 commits     █████░░░░░░░░░░░░░░░░░░░░   22.43% 
Wednesday    56 commits     ███░░░░░░░░░░░░░░░░░░░░░░   14.78% 
Thursday     44 commits     ███░░░░░░░░░░░░░░░░░░░░░░   11.61% 
Friday       28 commits     █░░░░░░░░░░░░░░░░░░░░░░░░   7.39% 
Saturday     30 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   7.92% 
Sunday       86 commits     █████░░░░░░░░░░░░░░░░░░░░   22.69%

Le drapeau SHOW_LANGUAGE peut être défini à False pour cacher les langages de programmation que vous utilisez.

💬 Languages:
JavaScript               5 hrs 26 mins       ███████████████░░░░░░░░░░   61.97%
PHP                      1 hr 35 mins        ████░░░░░░░░░░░░░░░░░░░░░   18.07%
Markdown                 1 hr 9 mins         ███░░░░░░░░░░░░░░░░░░░░░░   13.3%
Python                   22 mins             █░░░░░░░░░░░░░░░░░░░░░░░░   4.32%
XML                      8 mins              ░░░░░░░░░░░░░░░░░░░░░░░░░   1.62%

Le drapeau SHOW_OS peut être défini à False pour cacher vos détails d'OS.

💻 Operating Systems:
Windows                  8 hrs 46 mins       █████████████████████████   100.0%

Le drapeau SHOW_PROJECTS peut être défini à False pour cacher les projets sur lesquels on a travaillé.

🐱‍💻 Projects:
ctx_connector            4 hrs 3 mins        ███████████░░░░░░░░░░░░░░   46.33%
NetSuite-Connector       1 hr 31 mins        ████░░░░░░░░░░░░░░░░░░░░░   17.29%
mango-web-master         1 hr 12 mins        ███░░░░░░░░░░░░░░░░░░░░░░   13.77%
cable                    54 mins             ██░░░░░░░░░░░░░░░░░░░░░░░   10.41%
denAPI                   40 mins             ██░░░░░░░░░░░░░░░░░░░░░░░   7.66%

Le drapeau SHOW_TIMEZONE peut être défini à False pour cacher le fuseau horaire auquel vous appartenez.

⌚︎ Timezone: Asia/Calcutta

Le drapeau SHOW_EDITORS peut être défini sur False pour cacher la liste des éditeurs de code/IDE utilisés.

🔥 Editors:
WebStorm                 6 hrs 47 mins       ███████████████████░░░░░░   77.43%
PhpStorm                 1 hr 35 mins        ████░░░░░░░░░░░░░░░░░░░░░   18.07%
PyCharm                  23 mins             █░░░░░░░░░░░░░░░░░░░░░░░░   4.49%

Le drapeau SHOW_LANGUAGE_PER_REPO peut être défini à False pour cacher le nombre de dépôts dans différents langages de programmation et cadres.

Je code principalement en Vue

Vue          8 repos        ██████░░░░░░░░░░░░░░░░░░░   25.0% 
Java         6 repos        ████░░░░░░░░░░░░░░░░░░░░░   18.75% 
JavaScript   6 repos        ████░░░░░░░░░░░░░░░░░░░░░   18.75% 
PHP          3 repos        ██░░░░░░░░░░░░░░░░░░░░░░░   9.38% 
Python       2 repos        █░░░░░░░░░░░░░░░░░░░░░░░░   6.25% 
Dart         2 repos        █░░░░░░░░░░░░░░░░░░░░░░░░   6.25% 
CSS          2 repos        █░░░░░░░░░░░░░░░░░░░░░░░░   6.25%

Le drapeau SHOW_SHORT_INFO peut être défini sur False pour cacher l'information amusante courte d'un utilisateur.

Note

This section requires a Personal Access Token (PAT) with the user scope, otherwise the data shown here will be incorrect.

🐱 Mes données GitHub

🏆 433 Contributions en 2020

📦 Utilisé 292,3 kB dans le stockage de GitHub

💼 Opté pour l'embauche

📜 25 Répertoires publics

🔑 15 Répertoires privés appartenant

Le drapeau SHOW_LOC_CHART peut être défini à False pour cacher les lignes de code écrites dans différents trimestres de différentes années.

Le drapeau IGNORED_REPOS peut être défini à "waka-readme-stats, my-first-repo" (juste un exemple) pour ignorer certains répertoires que vous ne souhaitez pas compter.

Le drapeau SYMBOL_VERSION peut être défini pour le symbole de la barre de progression (par défaut : 1).

Version Bloc terminé Bloc vide
1
2
3

Le drapeau DEBUG_LOGGING peut être défini pour augmenter la verbosité de la sortie de l'action GitHub, par défaut égal à la propriété de débogage interne du runner

Chronologie

Graphique non trouvé

💖 Soutenez le projet

J'open-source presque tout ce que je peux, et j'essaie de répondre à tout le monde qui a besoin d'aide en utilisant ces projets. Évidemment, cela prend du temps. Vous pouvez utiliser ce service gratuitement.

Cependant, si vous utilisez ce projet et que vous êtes satisfait ou que vous souhaitez simplement me encourager à continuer à créer des choses, il y a quelques façons de le faire :-

  • Donner le crédit approprié lorsque vous utilisez cette action dans votre readme, en y faisant un lien de retour :D
  • Étoiler et partager le projet 🚀
  • paypal.me/aapreneur - Vous pouvez faire des dons uniques via PayPal. Je vais probablement acheter un peu de bière vin 🍷.

Merci ! ❤️

Contribution

Les contributions sont les bienvenues ♥ ! Veuillez partager toute fonctionnalité, et ajouter des tests unitaires ! Utilisez les systèmes de demande de tirage et de problèmes pour contribuer.

Contributeurs sélectionnés

  1. Anmol Pratap Singh: Mainteneur
  2. Alexander Sergeev: Mainteneur
  3. DataBoySu: Mainteneur
  4. okcoder1: Mainteneur
  5. Aravind V. Nair: Mainteneur
  6. Prabhat Singh: Pour le graphique du chronogramme du code #18
  7. Hedy Li: Pour la demande de tirage #34 et #23
  8. Pedro Torres: Pour la demande de tirage #29
  9. Aaron Meese: Pour la demande de tirage #45
  10. Arnav Jindal: Pour la demande de tirage #48
  11. Daniel Rowe: Pour la demande de tirage #57
  12. Ss5h: Pour l'ajout de la prise en charge de l'écriture de phrases naturelles pour la traduction #136
Special mention for those who are currently making their profile readme more awesome 😄 🎉
  • Et vous ! Si jamais vous l'utilisez actuellement et que vous n'êtes pas sur la liste, veuillez nous le faire savoir en envoyant un Special Mention ! 😊
    Nous serons ravis de vous ajouter à la liste.

Créé avec ❤️ et Python 🐍.

Inspiré de

Awesome Pinned Gists
athul/waka-readme

Ce projet a besoin d'une étoile ⭐ de votre part ♥

Stargazers au fil du temps

Stargazers over time