Skip to content
Snippets Groups Projects
Commit 16f3c14e authored by Thomas Dickson's avatar Thomas Dickson
Browse files

first two session ideas

parent 054d8df1
No related branches found
No related tags found
No related merge requests found
# Software development
# Algorithms
# Writing
\ No newline at end of file
# Good practice
- [Keeping a changelog](https://keepachangelog.com/en/1.0.0/)
\ No newline at end of file
...@@ -4,23 +4,34 @@ A repo describing the operations of the Marine Engineering code review sessions. ...@@ -4,23 +4,34 @@ A repo describing the operations of the Marine Engineering code review sessions.
## What ## What
A weekly session where we gather to share out problems with code. A weekly session where we gather to share out problems with code and broaden our understanding of concepts in software engineering.
## Why ## Why
Coding is easier when your problems are shared. This session can also act as a code review process for those preparing to share code for papers, theses or commercial practice. Coding is easier when your problems are shared. This session can also act as a code review process for those preparing to share code for papers, theses or commercial practice.
Sharing coding problems and strategies is a good way of working through [impostor syndrome](https://stackoverflow.blog/2020/02/10/hello-world-curing-imposter-syndrome-by-embracing-the-suck/).
## How ## How
1. Weekly session to physically gather and share problems. We'll have a specific theme to talk about for 5 minutes at the start of every meeting. 1. Weekly session to physically gather and share problems. We'll have a specific theme to talk about for 5 minutes at the start of every meeting.
2. Use of this repository to gather useful resources 2. Use of this repository to gather useful resources
1. Links in ```LINKS.md```
2. Good books in ```BOOKS.md```
3. The ```session_notes``` folder has markdown documents
# Weekly session # Weekly session
Vote on when you would like the weekly session to be held; https://vevox.app/m#/139064584 To be held on Mondays at 1400 somewhere on Boldrewood Campus. The format will be a short 5-10 minute presentation on a topic in software engineering before everyone splits into groups to start going through problems that they are having.
## Dates ## Dates
| Date | Theme | Sources | | Date | Theme | Location |
|------|------------|---------| |-------|-----------------|----------|
| ?? | Commenting | | | 24/02 | Code commenting | 176/2013 |
\ No newline at end of file | 03/03 | Big Oh notation | 176/2013 |
# Contributing
Please contribute any ideas you have. We want to learn more. Ideas for session themes, good resources and more are all welcome.
\ No newline at end of file
# Big O notation
Big O notation is a way of analysing algorithms.
## Sources
1. p31, Algorithm Analysis - The Algorithm Design Manual, Steven S. Skiena
1. p177, Algorithm Speed - The Pragmatic Programmer
\ No newline at end of file
# Comments
![Code quality](https://i.redd.it/btd5aebzr5h01.jpg)
Commenting your code is important if you want other people to use it after you. This does happen in academia and I'm told it happens in industry all the time.
> English is another programming language. (From the It's all writing section)
## Sources
1. Chapter 4, Clean code by Robert C. Martin.
1. It's all writing, The Pragmatic Programmer by Hunt and Thomas.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment