diff --git a/docs/2024-winter/images/github-kanban.png b/docs/2024-winter/images/github-kanban.png new file mode 100644 index 0000000..4babde8 Binary files /dev/null and b/docs/2024-winter/images/github-kanban.png differ diff --git a/docs/2024-winter/images/github.png b/docs/2024-winter/images/github.png new file mode 100644 index 0000000..472a057 Binary files /dev/null and b/docs/2024-winter/images/github.png differ diff --git a/docs/2024-winter/images/jira-kanban.png b/docs/2024-winter/images/jira-kanban.png new file mode 100644 index 0000000..52a69b1 Binary files /dev/null and b/docs/2024-winter/images/jira-kanban.png differ diff --git a/docs/2024-winter/images/jira.png b/docs/2024-winter/images/jira.png new file mode 100644 index 0000000..b348ace Binary files /dev/null and b/docs/2024-winter/images/jira.png differ diff --git a/docs/2024-winter/images/parts-of-git.png b/docs/2024-winter/images/parts-of-git.png new file mode 100644 index 0000000..3896bbf Binary files /dev/null and b/docs/2024-winter/images/parts-of-git.png differ diff --git a/docs/2024-winter/images/scrum.png b/docs/2024-winter/images/scrum.png new file mode 100644 index 0000000..5ea75f6 Binary files /dev/null and b/docs/2024-winter/images/scrum.png differ diff --git a/docs/2024-winter/images/versioning.png b/docs/2024-winter/images/versioning.png new file mode 100644 index 0000000..5b96426 Binary files /dev/null and b/docs/2024-winter/images/versioning.png differ diff --git a/docs/2024-winter/practical-software-engineering-workflow.md b/docs/2024-winter/practical-software-engineering-workflow.md new file mode 100644 index 0000000..4e68115 --- /dev/null +++ b/docs/2024-winter/practical-software-engineering-workflow.md @@ -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? + + + +???+ info "Scrums" + One example of "agile" ways of working and it looks like this. + ![scrum](images/scrum.png) + +## What is Git? + + +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) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 71dbbac..65ab43a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: