Skip to content

Latest commit

 

History

History
478 lines (306 loc) · 20.9 KB

File metadata and controls

478 lines (306 loc) · 20.9 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!

Dev-Metriken in README mit hinzugefügten Feature-Flags 🎌

Project Preview

Project Preview

📌✨Awesome README Stats


Star Badge

Bist du ein frühes 🐤 oder ein nächtliches 🦉?
Wann bist du am produktivsten am Tag?
Welche Sprachen codierst du?
Schauen wir es in deinem Profil-README an!

Bug melden Funktion anfordern

Vorbereitung

  1. Du musst die Markdown-Datei(.md) mit 2 Kommentaren aktualisieren. Du kannst hier nachlesen, wie du das machen kannst.
  2. Du benötigst einen WakaTime API-Schlüssel. Du kannst diesen in den Einstellungen deines WakaTime-Kontos abrufen
    • Du kannst hier nachlesen, wenn du neu bei WakaTime bist.
  3. Wenn du die Aktion zum Abrufen von Commit-Metriken ausführst, benötigst du einen GitHub API-Token mit repo und user Bereich von hier
    • Du kannst dieses Beispiel verwenden, um es zu verstehen.

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. Du musst den WakaTime API Key und den GitHub API Token in den Repository-Secrets speichern. Du kannst das in den Einstellungen deines Repositorys finden.
    Stelle sicher, sie unter folgenden Namen zu speichern:
    • WakaTime API Key als WAKATIME_API_KEY=<deiner wakatime API Key>
    • GitHub Personal Access Token (PAT) als GH_TOKEN=<dein github access token>
  2. Du kannst Feature-Flags basierend auf deinen Anforderungen aktivieren und deaktivieren.

Dieser GitHub Action kann so konfiguriert werden, dass er zu jedem Zeitpunkt, den du möchtest, mit cron läuft. Sieh dir Crontab.guru und dieses Website an, um cron Ausdrücke zu generieren.

Update your Readme

Füge einem Kommentar zu deinem README.md wie diesem hinzu:

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

waka kann durch jeden String ersetzt werden, der in der SECTION_NAME-Flag spezifiziert ist, wie in der verfügbaren Flags-Sektion beschrieben.

Diese Zeilen werden unsere Einstiegspunkte für die Entwickler-Metriken sein.

Neu bei WakaTime

WakaTime gibt dir einen Einblick in die Zeit, die du wirklich für das Coden aufwendest. Dies hilft dir, deine Produktivität und dein Wettbewerbsvorteil zu steigern.

Profil-Repository

Du wirst einen GitHub Access Token mit einem repo und user Umfang benötigen und ihn im Repo Geheimnis GH_TOKEN = <Dein GitHub Access Token> speichern.

Hier ist eine Beispielworkflow-Datei zum Ausführen:

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 }}
  • Jetzt kannst du commiten und warten, bis es automatisch läuft, oder du kannst es auch manuell auslösen, um das Ergebnis jetzt zu sehen. Gehe einfach zu Actions in deinem Repo, wähle deinen Profile Readme Development Stats Workflow aus und klicke auf Run workflow. Jetzt musst du nur noch ein oder zwei Minuten warten und du wirst deine Änderungen sehen.

Extras

Wenn du andere Informationen zu deinen Statistiken hinzufügen möchtest, kannst du mehrere FLAGS in deine Workflow-Datei einfügen. Standardmäßig sind alle Flags aktiviert (außer dem Flag für Zeilen von Code aufgrund der intensiven Operation, die durchgeführt wird)

- 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"

Flags Available


LOCALE Dieser Flag kann verwendet werden, um Statistiken in deiner Sprache anzuzeigen. Standard ist Englisch. Lokal Kurzform muss in der Flag-Variable übergeben werden. Ein Beispiel für das Endresultat kann hier gefunden werden.

Der SECTION_NAME-Flag kann auf jeden String gesetzt werden und wird der Name des Abschnitts sein, der im README ersetzt wird.

Der COMMIT_BY_ME-Flag kann auf True gesetzt werden, um den Code mit deinem Namen und E-Mail-Adresse zu committen.

Der COMMIT_MESSAGE-Flag kann für die Commit-Nachricht gesetzt werden. Der Standard ist "Updated with Dev Metrics".

Der COMMIT_USERNAME-Flag kann als Benutzername gesetzt werden, um den Code zu committen. Der Standard ist "readme-bot".

Der COMMIT_EMAIL-Flag kann auf eine E-Mail-Adresse gesetzt werden, um den Code zu committen. Der Standard ist "41898282+github-actions[bot]@users.noreply.github.com".

Der SHOW_UPDATED_DATE-Flag kann auf True gesetzt werden, um das aktualisierte Datum am Ende des Absatzes anzuzeigen.

Der UPDATED_DATE_FORMAT-Flag kann gesetzt werden, um das aktualisierte Datum in ein Format zu setzen. Der Standard ist "%d/%m/%Y %H:%M:%S".

Der SHOW_LINES_OF_CODE-Flag kann auf True gesetzt werden, um die Anzahl der geschriebenen Zeilen Code bis heute anzuzeigen.

Lines of Code

Der SHOW_TOTAL_CODE_TIME-Flag kann auf False gesetzt werden, um Code Time zu verbergen.

Code Time

Der SHOW_PROFILE_VIEWS-Flag kann auf False gesetzt werden, um Profile Views zu verbergen.

Profile Views

Der SHOW_COMMIT-Flag kann auf False gesetzt werden, um die Commit-Statistiken zu verbergen.

Ich bin ein frühes 🐤

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

Die SHOW_DAYS_OF_WEEK-Flagge kann auf False gesetzt werden, um die Commits, die an verschiedenen Tagen der Woche vorgenommen wurden, zu verbergen.

📅 Ich bin am produktivsten an Sonntagen

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%

Die SHOW_LANGUAGE-Flagge kann auf False gesetzt werden, um die von dir verwendeten Programmiersprachen zu verbergen.

💬 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%

Die SHOW_OS-Flagge kann auf False gesetzt werden, um deine OS-Details zu verbergen.

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

Die SHOW_PROJECTS-Flagge kann auf False gesetzt werden, um die bearbeiteten Projekte zu verbergen.

🐱‍💻 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%

Der SHOW_TIMEZONE-Flag kann auf False gesetzt werden, um die Zeitzone zu verbergen, in der du dich befindest.

⌚︎ Timezone: Asia/Calcutta

Der SHOW_EDITORS-Flag kann auf False gesetzt werden, um die Liste der verwendeten Code-Editoren/IDEs zu verbergen.

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

Die SHOW_LANGUAGE_PER_REPO-Flagge kann auf False gesetzt werden, um die Anzahl der Repositories in verschiedenen Programmiersprachen und Frameworks zu verbergen.

Ich codiere hauptsächlich in 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%

Der SHOW_SHORT_INFO-Flag kann auf False gesetzt werden, um die kurze, lustige Fakten-Info eines Benutzers zu verbergen.

Note

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

🐱 Meine GitHub-Daten

🏆 433 Beiträge im Jahr 2020

📦 292,3 kB in GitHub-Speicher verwendet

💼 Auf Suche nach Arbeit

📜 25 öffentliche Repositorys

🔑 15 private Repositorys, die ich besitze

Der SHOW_LOC_CHART-Flag kann auf False gesetzt werden, um die Zeilenanzahl, die in verschiedenen Quartalen unterschiedlicher Jahre geschrieben wurden, zu verbergen.

Der IGNORED_REPOS-Flag kann auf "waka-readme-stats, my-first-repo" (nur ein Beispiel) gesetzt werden, um einige Repositorys zu ignorieren, die nicht gezählt werden sollen.

Der SYMBOL_VERSION-Flag kann für das Symbol der Fortschrittsleiste gesetzt werden (Standard: 1).

Version Erledigter Block Leerer Block
1
2
3

Der DEBUG_LOGGING-Flag kann gesetzt werden, um die Ausgabelautstärke der GitHub-Action zu erhöhen, standardmäßig entspricht er der internen Debug-Eigenschaft des Laufers.

Zeitstrahl

Chart nicht gefunden

💖 Das Projekt unterstützen

Ich open-source fast alles, was ich kann, und versuche, auf jeden zu antworten, der Hilfe bei diesen Projekten benötigt. Offensichtlich dauert das Zeit. Du kannst diesen Service kostenlos nutzen.

Allerdings, wenn du dieses Projekt verwendest und damit zufrieden bist oder einfach nur möchte, dass ich weiterhin Dinge erstelle, gibt es ein paar Möglichkeiten, das zu tun :-

  • Gib bei Verwendung dieser Aktion in deinem Readme die richtige Quelle an und verlinke sie :D
  • Stern und teile das Projekt 🚀
  • paypal.me/aapreneur - Du kannst Einmalzahlungen über PayPal tätigen. Ich werde wahrscheinlich etwas Bier Wein 🍷 kaufen.

Danke! ❤️

Beiträge

Beiträge sind willkommen ♥! Bitte teile jede Funktion und füge Unit-Tests hinzu! Nutze das Pull-Request- und Issues-System, um beizutragen.

Ausgewählte Mitwirkende

  1. Anmol Pratap Singh: Maintainer
  2. Alexander Sergeev: Maintainer
  3. DataBoySu: Maintainer
  4. okcoder1: Maintainer
  5. Aravind V. Nair: Maintainer
  6. Prabhat Singh: Für den Code-Zeitlinien-Graphen #18
  7. Hedy Li: Für den Pull Request #34 und #23
  8. Pedro Torres: Für den Pull Request #29
  9. Aaron Meese: Für den Pull Request #45
  10. Arnav Jindal: Für den Pull Request #48
  11. Daniel Rowe: Für den Pull Request #57
  12. Ss5h: Für die Hinzufügung von Unterstützung für natürliche Satzformulierungen bei der Übersetzung #136
Special mention for those who are currently making their profile readme more awesome 😄 🎉
  • Und du! Wenn du es gerade jetzt verwendest und nicht auf der Liste stehst, melde dich bitte, indem du ein Special Mention-Issue erstellst! 😊
    Wir freuen uns, dich auf die Liste zu setzen.

Erstellt mit ❤️ und Python 🐍.

Inspiriert von

Awesome Pinned Gists
athul/waka-readme

Dieses Projekt benötigt ein Stern ⭐ von dir ♥

Stargazers über die Zeit

Stargazers over time