-
Start day: 2023.03.09
-
Meetings: Every Thursday 12:15-14:45
- Session 1: Welcome, Version Control, Journal, Slack
- Assignment 1
- Session 2: Finding projects, git workflows, ci, yaml
- Assignment 2
- Assignment 3
- Assignment 4
- Next
-
Welcome
-
About the course:
- Goal: Become familiar with tools and processes used for software development both in the industry and in the academic institutions through contribution to open source projects.
- List of tools we learn, they are all used in both academy and corporation, they could be used better in both places.
- Overview of the course
- Slack
- git
- GitHub
- Issues
- Pull Request
- Pages
- Actions
- (GitLab)
- Markdown (journal, issues, etc.)
- Docker
- Testing
- Static analysis
- End results:
- Blog posts (journal entries)
- Personal web site
- Issues (tickets) opened on various projects
- Pull-Requests sent to various projects
- Development of a personal open source project
-
About myself:
- Self employed
- Training
- Introducing testing, CI etc. to teams in corporations.
-
Assignments:
- Will be in some public GitHub or GitLab repositories.
- At the end of each assignment you'll write a report - a blog post / journal entry.
- You will add the link of your blog post to your personal JSON file and send a Pull-Request with the change. (We'll learn these soon)
- Video timstamping: Every week two people have to "timestamp" the videos. You can pick a video you'd like to do. If noone volunteers to do one of the videos I'll pick from the names so by the end of the semester everyone will do approximately the same number of videos.
- First few assignments will be to my projects. This allows for quick feedback and integration.
- Then to each others projects. This still allows for quick feedback.
- Then we'll find you open source projects maintained by other people. For these I might be able to give feedback, but I cannot integrate them.
-
Grades:
- Grades are based on the work done during the course.
- There is no end-project or exam at the end.
- Each week you'll get a grade of 0-100 and we'll have an average of them at the end of the semester.
-
How and why to blog/journal?
-
Why use version control?
-
What is JSON.
-
Pull request to add JSON, show drawing.
-
Use the cm-demo account to add enty to participant.
-
About GitHub Actions: they are programs triggered by some action. In this case by a pull request.
-
Video 1-1: (Yael Levy)
- 00:00 About the course
- 04:28 Overview of the course
- 18:46 About Gabor Szabo
- 20:15 Assighnments
- 23:05 Video timestamping
- 31:20 Grades
- 35:20 Blog posting
- 35:49 Dev.to
- 36:15 Post editor
- 39:18 Published
- 39:39 Description
- 40:10 Tags
- 48:28 Text in markdown
-
Video 1-2: (Eliyahou Levy)
- 00:00 Forem issues to solve bug
- 06:50 Inbound links
- 08:44 Version control
- 11:22 Json
- 14:36 Add json participant by pull request
- 16:30 Fork
- 25:35 Create pull request
- 27:40 Workflow
- 28:40 Approve pull request
- 30:00 Error handling
- 36:30 Sqush and merge pull request
- 37:43 Actions
- 39:02 Exercise definition-send pull request
- 42:50 Add comment
-
Create GitHub repository if you don't have one yet.
-
Add an image or an avatar to your GitHub account.
-
Add your JSON to our repository to the `participants/' folder.
-
List interesting projects in the JSON file.
-
Follow this git repository. Follow a number of other GitHub repositories that you find interesting or that you use.
-
Write a blog post about this on DEV.to
-
Include the link of the article in the JSON file.
-
Dead-line: 2023.03.14 midnight.
2023.03.16 12:15-14:30
-
Go over all the PRs people opened and the Issue I opened on our GitHub repository.
- Fix issue in PR instead of opening new one (show it)
- Mentioning commits in issues and issues in commits.
-
Blogging: linking, more details!
-
Ask to get the Video timestamping earlier.
-
Show how to follow projects on GitHub to get notifications.
-
The structure of a Github URL : https://github.com/(username|organization)
-
How to find a git repo of a project?
- Perl MetaCPAN
- Python PyPI
- 3rd party package registries
- Google search?
-
Video 2-1: (Freddy Adiv)
- 00:00 Recap of last session
- 07:25 Dev.to - navigation using tags
- 15:57 Opening issues in git
- 19:00 Issues and pull requests
- 30:55 Sample for real project interaction for Forem
- 42:10 Git project concepts, Forking and comminting
-
Video 2-2: (Freddy Adiv)
- 00:00 Locking files - pros and cons
- 02:50 Following a project and notifications in Git
- 05:35 Ranking mechanizm of projects
- 06:10 Sturcture of Git URLs, projects/ organizations/ repos
- 15:01 3rd party packages registry
- 17:45 Open source by orgznizations
- 21:35 YAML file format
- 31:15 Adding a new organization using YAML
- 50:22 Assignments for next week
-
Add (more) projects you are interested in.
-
Follow our project
-
Follow my projects
-
Follow each other's projects.
-
Convert 5 more organizations to yaml files.
-
Find more organizations. (more github organizations belonging to governments, universities, or corporations that are not even in the md files yet. I realize that converting the md files to yaml files should be probably the priority for this project so it might be better to do a few more of that.)
-
Write a blog post (tag with #osdc, notes, links, etc.)
-
Send a PR to add your blog post to your JSON file.
-
Dead-line: 2023.03.21 midnight.
-
Create Github pages.
-
Markdown.
-
Introduce git client.
- Setup local git configure, clone, add, commit, etc.
-
Download and install the git client from git-scm
-
In Windows, start the git-bash application
-
On Github create the USERNAME.github.io repository (with your USERNAME)
git clone git@github.com:cm-demo/cm-demo.github.io.git
cd cm-demo.github.io
mkdir docs
Create the file docs/index.md
git add .
git commit -m "first file"
Configure the git client (if it is not configured yet)
git config --global --add user.name "Foo Bar"
git config --global --add user.email foo@bar.com
cat ~/.gitconfig
Create private/public key pair. put the public key in your github account.
ssh-keygen
git commit --amend --reset-author -m "first commit"
git log
git status
git add docs/index.md
git commit -m "add more content"
git push
- Video 1: Ran Moshe
- 00:00 Windows - Oracle VM VirtualeBox
- 07:40 Back to local linux PC
- 07:50 Create repository for Github pages site (on Github)
- 09:11 Clone for create repository localy (on PC)
- 13:00 Download and install the git client from git-scm
- 15:05 In Windows, git-bash application
- 17:24 Setup local git configure (add, commit, config, etc.)
- 29:35 Create private/public key pair
- 35:10 Push changes (git push)
- 39:45 Congif github.io repository (on Github-settings)
- 42:38 Creating the Github page using Markdown
- 44:30 Push more changes (git status, add, commit, log. etc.)
- 47:50 The Github page after changes
- 48:45 Adding images to our Github page (add another file)
- 52:00 Push images and more changes (git status, add, commit, etc.)
- 54:23 Jekyll (from Markdown to Github)
- 55:30 Assignments for next week
-
Create a web site using GitHub pages, with cv, image, projects. Link to the course site, link to your blog. Use this to show a lot more interesting information about yourself to both your future employer, but also to friends and family. Check out what others in the other course did for inspiration.
-
Write a blog post about what you did, link it to the course web site, to your own new web site, to the pull-requests you made.
-
Update your JSON file with the new blog post and also add an entry of
"githu_page": trueto your JSON file if it is not there yet. -
Dead-line: 2023.03.28 midnight.
-
We looked at the PyDigger web site and the Stats page from where we had links to
-
projects have link to VCS but no author field
-
projects have link to VCS but no summary
-
projects where PyDigger did not find VCS
-
We looked at pypi page of numpy
-
We sent this Pull-Request
-
We found that the mrflagly project was missing the author field from the meta-data.
-
We went to its GitHub repository, found that it was using pyproject.toml and found the name and email of the author.
-
We also looked at pglib and saw that it is hosted on GitLab.
-
The licenses page on PyDigger was fixed a few hours before the lecture.
-
OSI approved Open Source licenses.
-
I mentioned the recommended books listed at the bottom of the OSDC main page. Especially I mentioned the one I am reading now Uncurled by Daniel Stenberg, author of curl.
-
Video 1: Ran Moshe
- 00:00 PyDigger and pypi.org (Introduction)
- 03:00 last updates of pypi (show in CLI- use grep & ack to get the relevant url)
- 04:45 PyDigger-Statistics
- 06:30 No VCS (PyDigger-Statistics)
- 07:50 CI (PyDigger-Statistics)
- 09:30 Has VCS (PyDigger-Statistics)
- 11:05 Has VCS license (PyDigger-Statistics)
- 12:35 Has VCS author (PyDigger-Statistics)
- 13:30 mrflalgy (example-Has VCS but no author)
- 14:40 pyproject.toml author field
- 20:00 Explain about pyproject.toml file & sending PR (mrflalgy- example)
- 32:20 types-pytz (example-Has VCS but no author)
- 34:50 pglib (example-Has VCS but no author (GitLab & setup.cfg file))
- 37:00 Has VCS summary (PyDigger-Statistics)
- 41:00 Adyen (example-Has VCS but no license)
- 41:56 Details Licenses page (PyDigger-Statistics)
- 45:10 Recommended books listed
- 46:10 open source initiative
- 51:00 searchkit (example-no VCS)
- 55:15 Assignments for next week
Find 5 (was 10) projects via PyDigger that have no author, not license, or no VCS. Add the missing information and send a pull-request. In the Pull-Request mention that you found the package missing this information via PyDigger, that you are sending it as part of the OSDC, and mention me as well: @szabgab
- Dead-line: 2023.03.28 midnight.
-
Comments:
- Send the deletition and addition in the same pull-request. Even better, in the same commit
- There were conflicts as the same person changed subsequent lines in separate changes.
-
Explain why linking and the anchors are important.
-
git-scm configure the default editor
-
Video 1: Ran Moshe
-
Video 2: Ran Moshe
- Video 1:
- Video 2:
- Video 1:
- Video 2:
- Video 1:
- Video 2:
- Video 1:
- Video 2:
- Video 1:
- Video 2:
- Video 1:
- Video 2:
- Video 1:
- Video 2:
- Video 1:
- Video 2: