Skip to content

Latest commit

 

History

History
477 lines (306 loc) · 20.7 KB

File metadata and controls

477 lines (306 loc) · 20.7 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étricas de Dev no README com bandeiras de recurso adicionadas 🎌

Project Preview

Project Preview

📌✨Awesome README Stats


Star Badge

Você é um 🐤 de manhã ou um 🦉 da noite?
Quando você é mais produtivo durante o dia?
Quais são os idiomas que você programa?
Vamos verificar no README do seu perfil!

Reportar Bug Solicitar Funcionalidade

Trabalho de Preparação

  1. Você precisa atualizar o arquivo markdown(.md) com 2 comentários. Você pode se referir aqui para atualizá-lo.
  2. Você precisará de uma chave de API WakaTime. Você pode obtê-la nas Configurações da Conta WakaTime
    • Você pode se referir aqui, se for novo no WakaTime.
  3. Você precisará de um token de API do GitHub com escopo repo e user de aqui se estiver executando a ação para obter métricas de commit.
    • Você pode usar este exemplo para trabalhar nisso.

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. Você precisa salvar a chave da API WakaTime e o token de acesso pessoal (PAT) do GitHub nos segredos do repositório. Você pode encontrá-los nas Configurações do seu repositório.
    Certifique-se de salvá-los da seguinte forma:
    • Chave da API WakaTime como WAKATIME_API_KEY=<sua chave da API WakaTime>
    • Token de Acesso Pessoal (PAT) do GitHub como GH_TOKEN=<seu token de acesso do github>
  2. Você pode habilitar e desabilitar bandeiras de recurso com base em suas necessidades.

Esta ação do GitHub pode ser configurada para executar em qualquer momento que você quiser usando cron. Veja Crontab.guru e este site para gerar expressões cron.

Atualize seu Readme

Adicione um comentário ao seu README.md assim:

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

waka pode ser substituído por qualquer string especificada na bandeira SECTION_NAME conforme a seção de bandeiras disponível.

Essas linhas serão nossos pontos de entrada para as métricas de dev.

Novo para WakaTime

WakaTime fornece uma ideia do tempo realmente gasto em codificação. Isso ajuda você a aumentar sua produtividade e vantagem competitiva.

Repositório de Perfil

Você precisará obter um GitHub Access Token com um escopo repo e user e salvá-lo nas Secrets do Repositório GH_TOKEN = <Your GitHub Access Token>

Aqui está um exemplo de arquivo de workflow para executá-lo:

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 }}
  • Agora você pode commitar e aguardar que ele execute automaticamente, ou também pode disparar para executar agora e ver o resultado. Basta ir até a Actions no seu repositório, selecione seu workflow Profile Readme Development Stats e clique em Run workflow. Agora aguarde um ou dois minutos e você verá suas alterações.

Extras

Se você quiser adicionar outras informações aos seus stats, você pode adicionar múltiplos FLAGS no seu arquivo de workflow. Por padrão, todos os flags estão habilitados (exceto o flag de linhas de código devido à operação pesada realizada)

- 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 Esta bandeira pode ser usada para mostrar estatísticas no seu idioma. O padrão é inglês. O código de localização Abreviação deve ser passado na variável da bandeira. Um exemplo do resultado final pode ser encontrado aqui

A bandeira SECTION_NAME pode ser definida como qualquer string e será o nome da seção para substituir no README.

A bandeira COMMIT_BY_ME pode ser definida como True para commitar o código usando seu nome e e-mail.

A bandeira COMMIT_MESSAGE pode ser definida para a mensagem do commit. O padrão é "Atualizado com Dev Metrics"

A bandeira COMMIT_USERNAME pode ser definida como um nome de usuário para commitar o código. O padrão é "readme-bot".

A bandeira COMMIT_EMAIL pode ser definida como um e-mail para commitar o código. O padrão é "41898282+github-actions[bot]@users.noreply.github.com".

A bandeira SHOW_UPDATED_DATE pode ser definida como True para mostrar a data de atualização no final do parágrafo.

A bandeira UPDATED_DATE_FORMAT pode ser definida para colocar a data de atualização em um formato. O padrão é "%d/%m/%Y %H:%M:%S".

A bandeira SHOW_LINES_OF_CODE pode ser definida como True para mostrar o número de linhas de código escritas até hoje.

Lines of Code

A bandeira SHOW_TOTAL_CODE_TIME pode ser definida como False para ocultar Code Time.

Code Time

A bandeira SHOW_PROFILE_VIEWS pode ser definida como False para ocultar Profile Views

Profile Views

A bandeira SHOW_COMMIT pode ser definida como False para ocultar as estatísticas de commit.

Sou um iniciante 🐤

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

O sinalizador SHOW_DAYS_OF_WEEK pode ser definido como False para ocultar as contribuições feitas nos diferentes dias da semana.

📅 Estou Mais Produtivo nos Domingos

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%

A bandeira SHOW_LANGUAGE pode ser definida como False para ocultar os idiomas de programação que você usa.

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

A bandeira SHOW_OS pode ser definida como False para ocultar os detalhes do seu sistema operacional.

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

A bandeira SHOW_PROJECTS pode ser definida como False para ocultar os projetos trabalhados.

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

A bandeira SHOW_TIMEZONE pode ser definida como False para ocultar o fuso horário no qual você está.

⌚︎ Timezone: Asia/Calcutta

A bandeira SHOW_EDITORS pode ser definida como False para ocultar a lista de editores de código/IDEs usados.

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

A bandeira SHOW_LANGUAGE_PER_REPO pode ser definida como False para ocultar o número de repositórios em diferentes linguagens de programação e frameworks.

Eu principalmente codifico em 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%

A bandeira SHOW_SHORT_INFO pode ser definida como False para ocultar a informação curta e divertida de um usuário.

Note

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

🐱 Meus Dados do GitHub

🏆 433 Contribuições no ano de 2020

📦 Usou 292.3 kB no armazenamento do GitHub

💼 Optou por Contratar

📜 25 Repositórios Públicos

🔑 15 Repositórios Privados Proprietários

A bandeira SHOW_LOC_CHART pode ser definida como False para ocultar as linhas de código escritas em diferentes trimestres de diferentes anos.

A bandeira IGNORED_REPOS pode ser definida como "waka-readme-stats, my-first-repo" (apenas um exemplo) para ignorar alguns repositórios que você não deseja que sejam contados.

A bandeira SYMBOL_VERSION pode ser definida para o símbolo da barra de progresso (padrão: 1).

Versão Bloco concluído Bloco vazio
1
2
3

A bandeira DEBUG_LOGGING pode ser definida para aumentar a verbosidade da saída da Ação do GitHub, por padrão igual à propriedade de depuração do executor interno

Linha do Tempo

Gráfico não encontrado

💖 Apoie o projeto

Eu open-source quase tudo que posso, e tento responder a todos que precisam de ajuda usando esses projetos. Obviamente, isso leva tempo. Você pode usar esse serviço gratuitamente.

No entanto, se você está usando esse projeto e está feliz com ele ou apenas quer me incentivar a continuar criando coisas, há algumas formas que você pode fazer isso :-

  • Dando o devido crédito quando usar essa ação no seu readme, vinculando de volta a ele :D
  • Estrelando e compartilhando o projeto 🚀
  • paypal.me/aapreneur - Você pode fazer doações únicas via PayPal. Eu provavelmente comprarei algum cerveja vinho 🍷.

Obrigado! ❤️

Contribuindo

Contribuições são bem-vindas ♥! Por favor, compartilhe quaisquer funcionalidades e adicione testes unitários! Use os sistemas de pull request e de issues para contribuir.

Contribuidores Selecionados

  1. Anmol Pratap Singh: Mantenedor
  2. Alexander Sergeev: Mantenedor
  3. DataBoySu: Mantenedor
  4. okcoder1: Mantenedor
  5. Aravind V. Nair: Mantenedor
  6. Prabhat Singh: Por gráfico de linha do tempo do código #18
  7. Hedy Li: Por Pull Request #34 e #23
  8. Pedro Torres: Por Pull Request #29
  9. Aaron Meese: Por Pull Request #45
  10. Arnav Jindal: Por Pull Request #48
  11. Daniel Rowe: Por Pull Request #57
  12. Ss5h: Por adicionar suporte para escrita de frase natural para tradução #136
Special mention for those who are currently making their profile readme more awesome 😄 🎉
  • E você! Se estiver usando ele agora e não estiver na lista, por favor nos avise criando um Special Mention issue! 😊
    Estaremos felizes em adicionar você na lista.

Feito com ❤️ e Python 🐍.

Inspirado em

Awesome Pinned Gists
athul/waka-readme

Este projeto precisa de uma estrela ⭐ de você ♥

Stargazers ao longo do tempo

Stargazers over time