Skip to content

Latest commit

 

History

History
105 lines (46 loc) · 5.41 KB

README.md

File metadata and controls

105 lines (46 loc) · 5.41 KB

How does this work?

During Odyssey Momentum Software Improvement Group (SIG) Code JEDI’s will support teams to write future-proof code by means of tooling and advice.

About the GitHub setup

  • All the GitHub teams and repos were created on forehand and email invites were send to the teamleads.
  • Please check these invite emails from GitHub.
  • Your repo is added to a team that is part of the OdysseyMomentum Organization
  • Your team repo is private. You can make the repo public, we welcome that.

Adding more team members?

If you need team members to be invited to your team please talk to FrankFonteijn or MichielCuijpers on Discord

More repos?

You can add more repos to your team yourself, first create the repository (using the + next to your profile icon). Then add the repo to your team -> repositories -> add -> and add the created respository. Adding the repo to your team will give your team members access.

Viewing Better Code Hub (BCH) results

Teams are invited to a private GitHub team repo where you can push your code continuously. The repo can be a private or public. For every commit BCH will automatically check the code quality. Viewing the results of of BCH is zero-setup. The code quality score is displayed on a 10 point scale.

Use GitHub oAuth to login to BCH and view results

  1. Go to Bettercodehub.com, login with your Github oAuth and accept the 3 scopes.

  2. Find you repo and get instant feedback on the guidelines and pick refactor candidates.

Together with the challenge leads SIG will qualify teams for a 'grill' session, which means a short interview by a SIG Code JEDI.

SIG Grill Session ?

During this 10 minute grill session, a SIG code JEDI will interview the team on the issue they are addressing with their solution, and how it was implemented. The grill session will act as a sanity check and touches on various software quality aspects, like maintainability, security and scalability. Additionally, the team will be challenged on their implementation approach and decision making process.

Last year, all teams that had passed the grill session received a golden balloon, this year your team will receive virtually an avatar with a golden balloon.

The results from the grill session will be visible on the teams MIRO-board, this will help to demonstrate the maturity of the prototype to the judges.

Sigrid-Says.com

BCH is linked to Sigrid, SIG’s software assurance platform. Challenge leads & challenge owners see in Sigrid how teams are performing. SIG Jedi will reach out to the challenge owners to give them access to the platform. Via a livestream SIG will be interviewed by Odyssey and will show & explain what we see in Sigrid.

Ok, what are those 10 guidelines?

  1. Your code will be evaluated against 10 guidelines for building future-proof code. The guidelines are described in full in “Building Maintainable Software”

  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. Better Code Hub integrates with the GitHub CI and runs at Pull Requests and Pushes.

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

How to get SIG support

Talk to us via Momentum or Discord

  1. The 2020 SIG Jedi team : Frank, Clarinda Dobbelaar, Hugo Schoonewille, Mousumi Samajdwer, Femke van Velthoven, Bugra Yildiz, Reinier Vis, Mees Kalf, Rakesh, Rudy Marsman, Martin Boerman, Jan Laan, Michiel Cuijpers

  2. After the event, through email.

How to qualify for a ‘grill session’ by SIG?

  1. If you score high on software quality your chances of being selected by the challenge lead increases significantly.

  2. The challenge lead will let you know when your team is selected.

  3. If you’re selected: visit the SIG meeting space to select your timeslot for the grill session.

  4. If you pass you get an avatar with a golden balloon, the results will be shared with the organizers and added to the teams MIRO-board.

How to exclude library files from analysis / change your configuration

  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

Read more

On why it needs high quality code

How a Hackathon appreciates quality code

Let's build some great software!!