/Blockchaingers.github.io

Primary LanguageCSS

Code quality matters during Blockchaingers Hackathon!

When: 5 - 8 April 2018

Where: The former Sugar Factory, Groningen NL

Website: Blockchaingers.org

How your code is evaluated

  1. Your code will be evaluated against 10 guidelines for building future-proof code. The guidelines are described in full in “Building Maintainable Software” (Ask for a free copy at the event)

  2. Find a concise reference card of the guidelines here.

  3. You can check your code against the guidelines using Better Code Hub, a GitHub integration provided by Software Improvement Group SIG. Better Code Hub integrates with the GitHub CI and can run at Pull Requests and Pushes.

  4. 16 modern programming languages are supported with a maximum codebase size 200 KLoc.

How to contact us

  • At the Hackathon please use slack bettercodehub_support Jan Laan or Michiel Cuijpers

How to get started

  1. All the teams were created on forehand and email invites were send. Please check these invite emails from GitHub.
  • Your team will be added in this BlockChaingers Organization
  • You will be a maintainer of your team, so you can add more people.
  • You will be able to create private repos and add please these to the team.
  • Your blockchainger repo can be a 'Git Remote'
  1. Add your repo to your team in the BlockChaingers Organization
  • You first need to add/create the repository within the blockchaingers org (using the + next to your profile icon)
  • then go to your team -> repositories -> add -> and add the created respository

  1. Go to bettercodehub.com and accept the scopes.

  2. Press play and get instant feedback on the guidelines and pick refactor candidates.

  3. Click on the Pull request icon to make Better Code Hub analyse every Push and Pull Request.

How to get support

  1. Before the event, through email.

  2. During the event by talking to Better Code Hub jedi with questions about refactoring tactics and blockchain implementation. use slack-channel: bettercodehub_support

  3. After the event, through email.

How to exclude your configuration / library files from analysis

  1. Get your current configuration file from your project settings. (Gear icon on bettercodehub.com)

  2. PLace that config in .bettercodehub.yml in your repository root

  3. Add a section called exclude, in there add the files/folders you want to exclude. Supported exclusion options can be found at the bettercodehub documentation

How to get points for technical quality?

  1. You get points based on your score in Better Code Hub.

  2. The more guidelines you get right, the more points you get.

  3. if you have multiple repos the lowest scoring repo is your final mark (weakest link principle).

  4. On Sunday April 8th between 10:30 and 11:59 ask for a sticker with your final score.

  5. Put the sticker on the canvas.

BlockChaingers Hackathon Scoreboard

Team Better Code Score
Example team BCH compliance

All the badges of the repos are collected here

Not on the scoreboard? Let the Better Code Hub team know on Slack or send a PR.

Why Blockchain needs Future-Proof code

Read more On why it needs high quality code

Or about the 2017 Dutch Blockchain Hackathon in Groningen

Let's build some great software!!

Michiel