Giter VIP home page Giter VIP logo

gh-readme-contrib's Introduction

gh-readme-contrib

Build

Weekly activity

Add chart to your repository

Your repository must be public, or at least you have to deploy the app with a custom github API token. To add the image on your repository, simply add the following line to your README:

![](https://gh-readme-contrib.herokuapp.com/api/author/repository)

Set config colors

The following query parameters are available:

name description type example
main the main color (chart curve) hex /api/edwinvautier/gh-readme-contrib?main=f0f
bg the background color hex /api/edwinvautier/gh-readme-contrib?bg=f0f
text text color hex /api/edwinvautier/gh-readme-contrib?text=f0f
display_number say if you want to display the current week commits number or not, default to true bool /api/edwinvautier/gh-readme-contrib?display_numbre=false

Setup

If you want more informations about the available make commands, run make help

If you already have the go.mod and go.sum files you can run :

make init
# or
make start

Branch naming convention

You branch should have a name that reflects it's purpose.

It should use the same guidelines as COMMIT_CONVENTIONS (feat, fix, build, perf, docs), followed by a dash (-) and a very quick summary of the subject in kebab case.

Example: feat-add-image-tag-database-relation.

Pull requests (PR)

Pull requests in this project follow two conventions, you will need to use the templates available in the ISSUE_TEMPLATE folder :

If your pull request is still work in progress, please add "WIP: " (Work In Progress) in front of the title, therefor you inform the maintainers that your work is not done, and we can't merge it.

The naming of the PR should follow the same rules as the COMMIT_CONVENTIONS

Linter

We use go linter gofmt to automatically formats the source code.

you can run make format to auto-format your files.

gh-readme-contrib's People

Stargazers

Alexandre Delaloy avatar

Watchers

Edwin Vautier avatar

gh-readme-contrib's Issues

refresh bug

the chart doesn't seem to update after a new week starts.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.