Skip to content
This repository has been archived by the owner on Jun 26, 2024. It is now read-only.

The first stop in your ASReview Hackathon adventure! Find all you need to know within this repository.

License

Notifications You must be signed in to change notification settings

asreview-ftm-hackathon/Introduction

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Introduction to the Hackathon

Welcome to the ASReview Hackathon for Follow the Money! 👋

Please read this document carefully before starting with the hackathon. Link to gather.town

Repositories

Set-up of this GitHub organization

In this GitHub organization you can find the following repositories:

  • Introduction: The repository where you are right now 😊. Here you can find this readme, the code of conduct and more information for each of the tracks.
  • Data: Containing both raw and basic pre-processed data and the data split into 10 smaller parts (more info on each in the README of this repository).
  • Example for data pre-processing track: One of our researchers, Jelle Teijema already did some pre-processing to create the basic pre-processed dataset for the visualization track (see data repository for the dataset itself). Take a look at his work for inspiration.
  • Example for visualization track: Not sure where to start for this track? Take a look at this repository for inspiration!

Naming your repository:

Please use the following name structure for your repository: trackname_groupname_contentname

Commits to your repository

Take a look at this blog post by Chris Beams to learn more about how to write better git commit messages!

The Schedule

You can find the program of the hackathon here.

Deliverables deadlines

During the hackathon, please be aware that there are some deliverable deadlines (which are also taken into account for the assessment of your work):

  1. Friday before 21:00: Submit your Team Name and Team captain* via the Google Sheets document (the link will be sent by your track lead beforehand).
  2. Saturday before 10:30: Create an empty/skeleton repository within this GitHub organization. The name should have the following format 'trackname_groupname_contentname'. :octocat:
  3. Saturday from 13:30: Present your initial concept/idea in a pitch (max. 2 minutes) in the track-expert GatherTown Office and get some feedback from your track-expert. 💡
  4. Sunday at 11:00: Finalize your GitHub repository including:
    • Readme
    • Output:
      • track 1: a clean dataset
      • track 2: art-work
      • track 3: a way of smart screening.
    • Scripts
    • (if applicable data)
  5. Sunday from 11:00: Present your final work in a 5 minute presentation! Presentations take place in the classroom part of your trackroom. 🥳

*As a Team captain, you are the contact-person of your team.

Assessment

All proposed solutions will be assessed on the following key points:

  • Deliverables: Were they submitted in time?
  • The proposed idea/solution as a concept
  • Cleanliness of code
  • Documentation of code
  • Structure of GitHub repository
  • Clearness of the readme (intended for someone with minimal coding experience)
  • Re-usability of the script
  • Final Pitch/Presentation
  • Is the repository public?
  • Track specific bonus

Each key point is worth a maximum of 10 points, thus the maximum score is 100.

License

Participants are asked to work under the MIT licence so that the code can be re-used for future data pre-processing. If participants used pre-existing code or work, they should credit the original author and be aware of licenses of the source. If in doubt, contact Jonathan de Bruin.

Code of Conduct

During the event, please be aware of the code of conduct. This code of conduct is based on the Hack code of conduct, with some minor adaptations. The quick version can be found below.

Quick version of the code of conduct:
 
Our hackathon is dedicated to providing a safe and comfortable environment and 
harassment-free experience for everyone, regardless of the following:
- gender
- gender identity and expression
- age
- sexual orientation
- disability
- physical appearance
- body size
- race
- ethnicity
- nationality
- religion
- political views
- previous hackathon attendance or lack of
- computing experience or lack of
- chosen programming language or tech stack

We do not tolerate harassment of hackathon participants in any form. Sexual language and 
imagery is not appropriate at any hackathon venue, this includes the following.
- hacks
- talks, presentations, or demos
- workshops
- any parties associated to the hackathon
- social media
- any other online media

Hackathon participants violating these rules may be sanctioned or expelled from the hackathon 
at the discretion of the hackathon organisers.

🎊 Enjoy the Hackathon!! 🎊

About

The first stop in your ASReview Hackathon adventure! Find all you need to know within this repository.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages