gh-readme-contrib

README

gh-readme-contrib

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 :

• Adding a new feature should use the FEATURE_REQUEST template.
• Reporting a bug should use the BUG_REPORT template.

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.