/github-integrations-template

Template with samples of badges and integration with other useful tooling for Github projects

Primary LanguageScalaMIT LicenseMIT

Github Integrations Template

Sample project showing how to integrate the most common Github Shields you see in Github projects. Although it's not a big effort to do this, having a central place with examples makes it easier to replicate and test.

Badges

You can log to all these apps with your Github account, no need for new user accounts.

Gitter

Gitter

  • URL: https://gitter.im/
  • What: Adds a chat channel for your project, accessible with Github accounts, so your userbase can communicate and discuss the project
  • Notes: if you create a channel from a repository, Gitter will create a pull request to add the badge to your Readme.md

Travis CI

Build Status

  • URL: https://travis-ci.org/
  • What: CI engine to use with open source projects
  • Notes: Clicking on the badge that is displayed in the project page in Travis CI shows the image url

Codacy

Codacy Badge

  • URL: https://www.codacy.com/
  • What: Automated code review of projects
  • Notes: Project settings provides the code for the badge

Waffle

Stories in Ready

  • URL: https://waffle.io/
  • What: Management of github issues
  • Notes: Project Settings > General provides code for the badge

Coveralls

Coverage Status

Bintray

Download

  • URL: https://bintray.com/
  • What: Place to publish your artifacts (jars)
  • Notes: Provides the code for the 'latest version' Badge under 'General' tab in project view