How does this evaluation work?
During the Odyssey Hackathon Software Improvement Group (SIG) Code JEDI will support the teams to write future-proof code by means of tooling and advice.
Teams will be invited to a GitHub team repo where they can push their code continuously. The repo can be a private or public (or remote git) repo. For every push BetterCodeHub (BCH) will automatically check the code quality. Installation of BCH is zero-setup. The code quality score is displayed on a 10 point scale. All the scores will be on a dashboard. All teams will receive a sticker with the final maintainability score for their canvas on Sunday.
The teams that score a 10/10 qualify for a short interview by a SIG Code JEDI. During this 10 minute session the JEDI will ‘grill’ your tech lead on the software engineering choices made: choice of technology, code architecture, security concerns and blockchain implementation. On passing the ‘grill’ session a Golden Balloon is awarded, this will help you demonstrate the maturity of your prototype to the judges.
Ok, what are those 10 guidelines?
-
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 masterclass on April 11th)
-
Find a concise reference card of the guidelines here.
-
You can check your code against the guidelines using Better Code Hub, a GitHub integration provided by Software Improvement Group. Better Code Hub integrates with the GitHub CI and can run at Pull Requests and Pushes.
-
17 modern programming languages are supported with a maximum codebase size 200 KLoc.
GitHub teams and private repos
- All the teams were created on forehand and email invites were send to the teamleads.
- Please check these invite emails from GitHub.
- Your team is added here Odysseyhack Organization
- We have create a private repo for you.
- Your repo can be a ‘Git Remote’
More private repos
- You can add more repos to your team yourself.
- You first need to create the repository within the org (using the + next to your profile icon)
- then add the repo to your team -> repositories -> add -> and add the created respository
- be aware of the weakest-link -principle
GitHub oAuth to login to Better Code Hub and run analysis
-
Go to Bettercodehub.com, login with your Github oAuth and accept the 3 scopes.
-
Press play and get instant feedback on the guidelines and pick refactor candidates.
-
Click on the Pull request icon to make Better Code Hub analyse every Push and Pull Request.
How to get support
-
Before the event, through email.
-
During the event by talking to Better Code Hub JEDI with questions about refactoring tactics and code implementation. use
-
At the Hackathon please use Odyssey community bettercodehub_support
-
After the event, through email.
How to get a sticker with my score
-
The more guidelines you get right, the higher the final score.
-
if you have multiple repos the lowest scoring repo is your final mark (weakest link principle).
-
On Sunday April 14th between 9:00 and 11:59 ask for a sticker with your final score.
-
Put the sticker on the canvas.
How to get Grilled
-
If you score a 10/10 then you qualify!
-
pick your 10 minute slot for your session
-
get Grilled..
-
if you pass you get a Golden Balloon
Odyssey Hackathon Scoreboard
All the badges of the repos are collected here Not on the scoreboard? Let the Better Code Hub team know on Mobilize or send a PR.
How to exclude library files from analysis / change your configuration
-
Get your current configuration file from your project settings. (Gear icon on bettercodehub.com)
-
PLace that config in .bettercodehub.yml in your repository root
-
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
Why your Odyssey 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!!