2024 Hackathon:
Creating a Code Standard
Natalie van Dis & Arthur Rodrigues
Code Club 👩🏽💻👨🏻💻👨🏼💻
Hackathon schedule
06:00 - 06:20 --- Introduction to Hackathon [20 min]
06:20 - 06:30 --- Sign-up + Set-up your working directory [10 min]
06:30 - 07:43 --- Hack away at the Hackathon (with breaks) [75 min]
07:43 - 07:55 --- General Discussion & Wrap up [12 min]
--- 07:55 END HACKATHON ---
Introduction to Hackathon
Natalie van Dis☀️🐙�color me now please
Arthur Rodrigues☀️🦜�color me now please
tietokone
computer
computador
SORTEE Code Club🎉
https://www.sortee.org/code_club/
Every third Tuesday of the month
Code Club 👩🏽💻👨🏻💻👨🏼💻
SORTEE Code Club🎉
Code Club 👩🏽💻👨🏻💻👨🏼💻
✨Become SORTEE Code Club Leader 2025! ✨
Code Club 👩🏽💻👨🏻💻👨🏼💻
Best practices for Open, Reliable and Transparent (ORT) Code
❕SORTEE Open Code Primer
Stefan Vriend, Joey Burant & Freddy Hilleman
Why a Code Standard?
➡️ Simple, real-life examples for common Ecology & Evolution analyses
The “perfect” Open, Reliable and Transparent (ORT) Code for EE
🤝Today = Decide as a community
What edits needed to make the code as easy as possible for someone else to understand, run, and reuse?
Hackathon outline
Poll results
Selected piece of R code
😅/😰
Simple Ecol & Evol analysis:
Estimate fitness curve from experimental data
Fitness measures:
Six groups
Stefan Vriend, Joey Burant & Freddy Hilleman
How-to Hackathon
Hackathon schedule
06:00 - 06:20 --- Introduction to Hackathon [20 min]
06:20 - 06:30 --- Sign-up + Set-up your working directory [10 min]
06:30 - 07:43 --- Hack away at the Hackathon (with breaks) [75 min]
07:43 - 07:55 --- General Discussion & Wrap up [12min]
--- 07:55 END HACKATHON ---
Breakout rooms
How-to work in zoom
Breakout room: Group X (main room)
Breakout room: Group X (side room1)
Breakout room: Group X (side room2)
✏️
HackMD
Task 1: xxxx
Task 2: xxxx
………..
How-to work in zoom
Breakout room: Group X (main room)
Breakout room: Group X (side room1)
Breakout room: Group X (side room2)
Task 2
✏️
HackMD
Task 1: xxxx
Task 2: xxxx
Task 3: xxxx
Task 4: xxxx
🖥️
⌨️
Task 1
🖥️
⌨️
How-to work in zoom
How-to work in zoom
How to work with Git and Github
Git commands (command line)
cd <project location> # change directory to your project folder
ls # list folder contents
git clone <https to your Github repo> # clone a repository from Github
git switch <branch name> # switch to another branch
git branch # check in which branch you are working
git status #Your best friend! Check the status of your project files
git add <your_file.name> # add untracked files/changes to Git
git commit -m “Your message” # commit your changes with a descriptive message
git push # push your changes to Github
git pull # pull any changes made on Github to your local folder
Git commands (command line)
cd <project location> # change directory to your project folder
ls # list folder contents
git clone <https to your Github repo> # clone a repository from Github
git switch <branch name> # switch to another branch
git branch # check in which branch you are working
git status #Your best friend! Check the status of your project files
git add <your_file.name> # add untracked files/changes to Git
git commit -m “Your message” # commit your changes with a descriptive message
git push # push your changes to Github
git pull # pull any changes made on Github to your local folder
Sign-up + Set-up your working directory [10 min]
Sign-up + Set-up your working directory [10 min]
Sign-up + Set-up your working directory [10 min]
❕➡️ All links and instructions can be found on Github� 📑Please bookmark the Github repo
Time left? Break time ☕
Hackathon schedule
06:00 - 06:20 --- Introduction to Hackathon [20 min]
06:20 - 06:30 --- Sign-up + Set-up your working directory [10 min]
06:30 - 07:43 --- Hack away at the Hackathon (with breaks) [75 min]
07:43 - 07:55 --- General Discussion & Wrap up [12min]
--- 07:55 END HACKATHON ---
Breakout rooms
❕Find your group in the Sign-up sheet
General Discussion & Wrap up [12 min]
Each group: please share your main code edits � [max 1min per group]
If have time: Anything else you would like to share?
Where do we go from here?
Any feedback about today? Let us know in the HackMD
❕keep an eye on Slack
💗Thank you for participating!!
We will keep you updated on Slack
#conf2024-h07-creating-a-code-standard
#code_club
✨Become SORTEE Code Club�Leader 2025! ✨
Code Club 👩🏽💻👨🏻💻👨🏼💻
Git help
Common error when collaborating in the same repository
Workflow: pull -> modify the file -> add -> commit -> pull -> push
solution
Common error when collaborating in the same repository
Workflow: pull -> modify the file -> add -> commit -> pull -> push
Some of you will get an error when pull
When git asks you to write a merge message…
How to write a merge message, save, and exit in Windows git bash:
Alternatively type: :wq # write and quite
Solving conflicts
To solve the conflict you should edit the section with conflict.
Edit the conflict lines and save the file
Current commit
Previous commit
Conflict section
Solving conflicts
After edit and save: add -> commit -> push