Skip to content

Commit

Permalink
Copied Practical Software Engineering Workflow Workshop to 2024 Winte…
Browse files Browse the repository at this point in the history
…r workshop page (#33)
  • Loading branch information
CodeWithTheDoctor authored Jun 20, 2024
1 parent e31cada commit b0474f4
Show file tree
Hide file tree
Showing 9 changed files with 97 additions and 0 deletions.
Binary file added docs/2024-winter/images/github-kanban.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024-winter/images/github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024-winter/images/jira-kanban.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024-winter/images/jira.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024-winter/images/parts-of-git.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024-winter/images/scrum.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024-winter/images/versioning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
96 changes: 96 additions & 0 deletions docs/2024-winter/practical-software-engineering-workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
title: Practical Software Engineering Workflow
ᴴₒᴴₒᴴₒ: true
---

*How software engineer [GSD](https://www.atlassian.com/team-playbook/plays/gsd-day)!*

## How do software engineers work?
They use **issue/ticket management system** to track their work.

???+ example "Github Issues and Jira"
The examples are Github Issues and Jira.

![github](images/github.png)
![jira](images/jira.png)

Listing of issues can be displayed in **kanban boards**.

???+ example "Kanban Boards"

![github-kanban](images/github-kanban.png)
![jira-kanban](images/jira-kanban.png)

## Why do Software Engineers Work like this?

<iframe width="100%" height="500rem"
src="https://www.youtube.com/embed/oyVksFviJVE"
frameborder="0"
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen></iframe>

???+ info "Scrums"
One example of "agile" ways of working and it looks like this.
![scrum](images/scrum.png)

## What is Git?
<iframe width="100%" height="500rem"
src="https://www.youtube.com/embed/hwP7WQkmECE"
frameborder="0"
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen></iframe>

Git is a

- **version control system**
- tools for **coordinating work for different changes**

### Main Parts of Git

Main Parts of git:

- Change Node (commit node)
- Branch

![parts-of-git](images/parts-of-git.png)

### Git Different Versions

??? info "Software Versions"
![versioning](images/versioning.png){align=left}

**Nodes**
- Representation of a change (commits + merge)

**Main/Master:**
- Branch usually as production or deployed

**Development Branch**
- Branch used for development
Used for compiling features for a release

**Feature Branch**
- Branch used for development for a
particular issue

## GitHub and Code Repositories

**GitHub**
- Place to hold code repositories

**Repositories**
- Place where codes are stored with different versions


## INTERACTIVE WORKSHOP TIME !!!!
1. Do the following from [codersforcauses/software-engineering-practices-demo](https://github.com/codersforcauses/software-engineering-practices-demo-2024-winter): Demonstration of software engineering practices (github.com):
2. Look at the GitHub issues
3. Assign yourself an issue
4. Clone repo with `git clone https://github.com/codersforcauses/software-engineering-practices-demo-2024-winter.git`
5. Create a branch with the following format s{Issue Number}-{Issue Name}. `git checkout -b {Issue Number}-{Issue Name}`
6. Create the change to satisfy or complete the github issue
7. Commit (package) the change `git commit -m "{insert message here}"` and push git push.
8. Create a pull request and request for a reviewer from CFC peeps

## Other Resources
- [Git and Github](https://www.youtube.com/watch?v=HkdAHXoRtos)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ nav:
- Contributions: contributions.md
- 2024 Winter:
- Introduction to Docker: 2024-winter/introduction-to-docker.md
- Practical Software Engineering Workflow: 2024-winter/practical-software-engineering-workflow.md
- 2023 Winter:
- Introduction to Backend Development With Django: 2023-winter/introduction-to-backend-development-with-django.md
- 2022/2023 Summer:
Expand Down

0 comments on commit b0474f4

Please sign in to comment.