release 0.2 - humphd/topics-in-open-source-2024 GitHub Wiki

Release 0.2

Due Date

Thursday October 31 by Midnight, with weekly blog posts and updates to the wiki below throughout October

Overview

This second release is meant to get you contributing to real open source projects, furthering your git, GitHub, and open source experience.

For the month of October, we will be participating in Hacktoberfest, a yearly event to encourage new people to get involved in the open source community.

I have created a video to discuss Hacktoberfest and this release in more detail, which you are encouraged to watch before you begin.

You can also read my blog posts about Seneca open source students doing Hacktoberfest in the past

Learning Goals

The goal of this second release is to help you gain experience and confidence in contributing to open source projects through direct involvement in a number of real projects. As a result, you will learn more about what it's like to work within the open source development community. Finally, you will participate in a global event, and get a chance to network in the industry.

This release will also help you to continue to develop your blogging skills, and practice software planning, estimating, and scheduling, as you work to complete your pull requests each week.

Hacktoberfest

Start by registering with your GitHub info on the Hacktoberfest web page. You might also want to join the Hacktoberfest Discord server, in order to get help or find interesting projects.

You are then asked to complete 4 pull requests during October, doing roughly 1 pull request per week. All 4 PRs must be completed by Oct 31, and you are asked to work on 3 separate repos/projects (i.e., you can't do all 4 PRs in one project). You will also be required to blog each week about your progress (see below). The complete list of rules for Hacktoberfest are here.

You are expected to make steady progress through your 4 pull requests. That is, each one should build on the previous one in some way. You can't, for example, fix 4 spelling mistakes--but you could fix one for your first PR. Rather, use each pull request as an opportunity to try something new, and to push yourself a little bit further. Your 4th PR should be more complex and larger than your third, etc.

You shouldn't take on huge issues in projects you don't understand and overwhelm yourself. But you should challenge yourself to work just a bit outside your current skill and comfort zones. The goal is to progress in your experience, competence, and confidence.

NOTE: many people "cheat" at Hacktoberfest by creating repositories that are simply lists of words, movie titles, algorithms, etc and aren't really open source projects. Please refrain from contributing to these repos. Make sure you are picking issues from existing, real open source projects. If you're not sure, ask your professor.

Picking Open Source Projects

You can work on any GitHub hosted open source project, but be aware of the following:

  1. You may not work on a student project, or a project for another class (e.g., I will not count PRs to repos from 0.1)
  2. Look for repos with the Hacktoberfest topic and/or Issues with the Hacktoberfest label. If you want to work on a repo/issue that doesn't have the "Hacktoberfest" topic or label, ask the maintainers of the project if they can add it for your PR when merging.
  3. Look at the open source projects that previous Seneca students worked on during Hacktoberfest in 2018, 2019, 2020, 2021, 2022.
  4. You should avoid "Hacktoberfest" specific repos, which are created simply to allow people to create silly PRs (i.e., "add your name to this list!"). Pick real open source projects.
  5. You should avoid projects that are abandoned or no longer actively maintained. Pick active projects, where you can get your work merged.
  6. You need to work on 3 different GitHub repos during the month.

If you are unsure whether a repo or project is acceptable, ask your professor.

Finding Issues to Work on

When you're new to open source, finding good issues takes time (often a lot of time), so be patient and leave yourself plenty of time. Also be aware that there will be tens-of-thousands of other people contributing to Hacktoberfest, and competing with you for issues.

Here are some links to queries and tools for finding potential issues to work on:

Some other tips when searching for issues on GitHub:

  • You can specify the user field, if you want to limit your search to an organization or company, for example user:microsoft would show only issues belonging to Microsoft repos.
  • You can limit to a particular programming language using the language field, language:python.

Fixing Your Issues

I have created two videos to walk you through the process of contributing to open source projects on GitHub:

When you find an issue that you want to work on, you are encouraged to leave a comment telling the project maintainers. This will help signal to other developers that you are working on it, and (hopefully) not submit a fix. Some people don't follow this rule, and submit fixes anyway. If this happens to you, talk to your professor.

Submit a pull request for your fix, following all guidelines for the project (see their README.md and CONTRIBUTING.md docs). Make sure your pull request is high quality, doesn't touch lines/files that aren't related to your fix, and has proper indenting and code formatting. Pay attention to small things.

You are expected to make any fixes that your reviewers request in subsequent commits. Be professional in your communication and the code you submit. Submitting a pull request, but then abandoning it when you get feedback, is not acceptable.

Getting Help

At every stage of your work, make sure you ask for help, and get feedback from others in the community by asking questions. Don't struggle on your own and get stuck, or miss the due date.

Please use Slack to help with communication. If you can't get a maintainer for a repository to respond to your Issues, or give feedback on reviews, you should try and reach out on Slack. If that doesn't work, consider switching to contribute to another repository.

Weekly Blogging

Each week during October you will be asked to blog about your progress. These blogs will help you stay on track, and spread your work out during the month. You cannot possibly do this assignment the week or night before it is due, so manage your time well.

Your blog posts should include things like:

  • Which issue did your work on? Always include links to URLs so readers can find them.
  • What was the issue about?
  • What did you need to do to prepare the fix? Was there much setup?
  • What did you need to learn in order to make the fix?
  • Explain the code for your fix. How does it work?
  • If possible, include some kind of demo of the code before/after the fix (not all issues will lend themselves to this, but if you can, consider using screenshots, etc).
  • What research did you do? Were there aspects of the issue that you found difficult?
  • Did you have any interesting interactions with the project maintainers?
  • What did you find difficult? How did you overcome this?
  • Link to your Pull Request

Requirements

You will be graded on the following. Please make sure you have addressed everything that makes sense below:

  • Four (4) approved Pull Requests completed on time (i.e., not all in the final week) and including at least 3 different project repos.
  • Clear progression in your work (i.e., you did more than fix 4 spelling mistakes). Talk about this in your final blog post.
  • Professional and respectful interactions in your issue with maintainers, good communication in issues and pull requests.
  • Pull Requests should reference the Issue Number in its description (e.g., "Fixes #7: Add feature to do ..."), and include sufficient information about changes you made
  • All work is done on a new branch (e.g., if you are fixing Issue 123, use issue-123 as your branch name)
  • Proper code to fix your Issues
  • Code follows style of the original repository author(s)
  • All review comments have been addressed, and subsequent commits have been added to correct any problems. Ideally your Pull Request is merged.
  • Weekly Blog Posts
    • Discussion of the changes you made. What was your process? What did you learn? What would you do differently next time, or what worked and you would do again?
    • Link to the Issues you filed, and discuss the bug/problem/addition you wanted to address.
    • Link to the Pull Requests you created, and discuss the fix.
    • Discussion of what you did to address your review comments.
  • Final recap blog post about everything you did in October, how you've progressed, and what you learned.

Submission

Please add a section for yourself to this wiki page, copy/pasting the template below. Each week you should update your data for blogs, pull requests and issues you are working on:

Template

GitHubUserName - Student Name

Issues
Pull Requests
Blog Posts

Mounayer - Majd Al Mnayer

Issues
  1. https://github.com/Ashish-simpleCoder/classic-react-hooks/issues/55
  3. https://github.com/blenderskool/blaze/issues/172
  4. https://github.com/huggingface/chat-ui/issues/1432
Pull Requests
  1. https://github.com/Ashish-simpleCoder/classic-react-hooks/pull/69
  3. https://github.com/blenderskool/blaze/pull/176
  4. https://github.com/huggingface/chat-ui/pull/1539
Blog Posts
  1. https://dev.to/majd_almnayer_2101/my-first-hacktoberfest-45j2
  2. https://dev.to/majd_almnayer_2101/contributing-to-open-source-c-edition-255a
  3. https://dev.to/majd_almnayer_2101/p2p-websockets-webtorrent-3om1
  4. https://dev.to/majd_almnayer_2101/hacktoberfest-conclusion-hugging-face-finale-4hj4

AryanK1511 - Aryan Khurana

Issues
  1. https://github.com/zero-to-mastery/ZTM-Quest/issues/36
  2. https://github.com/Canner/WrenAI/issues/713
  3. https://github.com/apache/airflow/issues/42823
  4. https://github.com/ToolJet/ToolJet/issues/10977
Pull Requests
  1. https://github.com/zero-to-mastery/ZTM-Quest/pull/63
  2. https://github.com/Canner/WrenAI/pull/724
  3. https://github.com/apache/airflow/pull/42964
  4. https://github.com/ToolJet/ToolJet/pull/10982
Blog Posts
  1. https://aryank1511.hashnode.dev/hacktoberfest2024-blog1
  2. https://aryank1511.hashnode.dev/hacktoberfest2024-blog2
  3. https://aryank1511.hashnode.dev/hacktoberfest2024-blog3
  4. https://aryank1511.hashnode.dev/hacktoberfest2024-blog4
  5. https://aryank1511.hashnode.dev/hacktoberfest2024-blog5

Kannav02 - Kannav Sethi

Issues
Pull Requests
  1. https://github.com/brombomb/f1hub/pull/91
  2. https://github.com/DiceDB/dice/pull/975
  3. https://github.com/zero-to-mastery/ZTM-Quest/pull/115
  4. https://github.com/planetarium/www.nine-chronicles.dev/pull/92
  5. https://github.com/DiceDB/dice/pull/1170
Blog Posts
  1. https://dev.to/kannav02/my-first-hacktoberfest-contribution-5a06
  2. https://dev.to/kannav02/my-hacktobefest-contribution-to-dicedb-4egg
  3. https://dev.to/kannav02/hacktoberfest-contribution-to-ztm-quest-d38
  4. https://dev.to/kannav02/my-fourth-and-final-contribution-to-hacktoberfest-1g8d

cleobnvntra - Cleo Buenaventura

Issues
  1. https://github.com/surreal30/Food-Data-Scrapper/issues/2
  2. https://github.com/vigneshs-dev/Q-Vote/issues/22
  3. https://github.com/onlook-dev/onlook/issues/524
  4. https://github.com/onlook-dev/onlook/issues/147
Pull Requests
  1. https://github.com/surreal30/Food-Data-Scrapper/pull/3
  2. https://github.com/vigneshs-dev/Q-Vote/pull/26
  3. https://github.com/onlook-dev/onlook/pull/558
  4. https://github.com/onlook-dev/onlook/pull/646
Blog Post
  1. https://dev.to/cleobnvntra/hacktoberfest-2024-part-1-110m
  2. https://dev.to/cleobnvntra/hacktoberfest-2024-part-2-1ldj
  3. https://dev.to/cleobnvntra/hacktoberfest-2024-part-3-2jlo
  4. https://dev.to/cleobnvntra/hacktoberfest-2024-part-4-887
  5. https://dev.to/cleobnvntra/reflecting-on-hacktoberfest-2024-43k4

fadingNA - Nonthachai Plodthong

Issues
Pull Requests
  1. PR Update KeyError, _evaluate function, _save_checkpoint function
  2. PR Update Type for Scrape-it
  3. PR Add New Feature for caching LLM response using Redis
  4. PR Update Docstring for Button behavior with variant
Blog Posts
  1. First PR Transformer
  2. Second PR Scrape IT
  3. Third PR DocsGPT Caching
  4. Fourth PR Gradio Document API Update
  5. Recap Hacktober Fest

brokoli777 - Bregwin Jogi

Issues
Pull Requests
  1. https://github.com/tldr-pages/tldr/pull/13934
  2. https://github.com/nats-io/nats.docs/pull/752
  3. https://github.com/ScottPlot/ScottPlot/pull/4335
  4. https://github.com/microsoft/vscode-python/pull/24300
  5. https://github.com/mozilla/mozdownload/pull/703
  6. https://github.com/google/magika/pull/739
Blog Posts
  1. https://dev.to/bregwin/getting-started-with-hacktoberfest-my-first-open-source-contributions-54pc
  2. https://dev.to/bregwin/contributing-to-other-open-source-projects-week-2-p94
  3. https://dev.to/bregwin/contributing-to-open-source-projects-3-dij
  4. https://dev.to/bregwin/from-regex-to-ruff-lessons-learned-in-contributing-to-magika-2be6
  5. https://dev.to/bregwin/a-brief-recap-of-what-i-did-this-month-40e1

peterdanwan - Peter Wan

Issues
Pull Requests
  1. https://github.com/tarasglek/chatcraft.org/pull/692
  2. https://github.com/beRajeevKumar/Frontend_Mentor/pull/59
  3. https://github.com/beRajeevKumar/Frontend_Mentor/pull/182
  4. https://github.com/microsoft/vscode/pull/230987
  5. https://github.com/aayushai/TranspilerX/pull/37
  6. https://github.com/aayushai/TranspilerX/pull/29
  7. https://github.com/PlasmoHQ/plasmo/pull/1122
  8. https://github.com/streetsidesoftware/vscode-spell-checker/pull/3729
Blog Posts
  1. https://dev.to/peterdanwan/devlog-hacktoberfest-2024-14-23b
  2. https://dev.to/peterdanwan/devlog-hacktoberfest-2024-24-32ja
  3. https://dev.to/peterdanwan/devlog-hacktoberfest-2024-34-44f
  4. https://dev.to/peterdanwan/devlog-hacktoberfest-2024-44-k2m
  5. https://dev.to/peterdanwan/hacktoberfest-2024-a-retrospective-3a7c

uday-rana - Uday Rana

Issues
Pull Requests
Blog Posts

lilyhuang-github - Lily Huang

Issues
Pull Requests
Blog Posts

arilloid - Arina Kolodeznikova

Issues
Pull Requests
  1. https://github.com/sparshg/battleship/pull/19
  2. https://github.com/mattermost/docs/pull/7463
  3. https://github.com/ohcnetwork/care/pull/2547
  4. https://github.com/SandeepVashishtha/Code-Editor/pull/17
Blog Posts
  1. https://dev.to/arilloid/hacktoberfest-2024-1st-contribution-34i2
  2. https://dev.to/arilloid/hacktoberfest-2024-2nd-contribution-1med
  3. https://dev.to/arilloid/hacktoberfest-2024-3rd-contribution-l7l
  4. https://dev.to/arilloid/hacktoberfest-2024-last-contribution-recap-337h

HTSagara - Henrique Sagara

Issues
Pull Requests
  1. https://github.com/neomjs/pages/pull/5
  2. https://github.com/neomjs/neo/pull/6021
  3. https://github.com/shardeum/validator-dashboard/pull/40
  4. https://github.com/manascb1344/Online-Auction-System/pull/15
Blog Posts
  1. https://dev.to/htsagara/hacktoberfest-week-1-f8j
  2. https://dev.to/htsagara/hacktoberfest-week-2-shardeum-validator-dashboard-dl
  3. https://dev.to/htsagara/hacktoberfest-week-3-online-auction-system-4knp

TheoForger - Theo

Issues
Pull Requests
Blog Posts

AnhChienVu - Anh Chien Vu

Issues
Pull Requests
Blog Posts

hpatel292-seneca - Harshil Patel

Issues
Pull Requests
Blog Posts

cduarte3 - Christian Duarte

Issues
Pull Requests
Blog Posts

Add00 - Adam Davis

Issues
Pull Requests
Blog Posts

aldrin312 - Aldrin Fernandez

Issues
Pull Requests
Blog Posts

mpa-LHutchinson - Liam Hutchinson

Issues
  1. https://github.com/computerclubkec/computerclubkec.github.io/issues/59
  2. https://github.com/InDieTasten/ASCII-mate/issues/35
  3. https://github.com/bodonovan/wordle_cheat/issues/3
  4. https://github.com/jessesimpson36/yamldifftool/issues/1
Pull Requests
  1. https://github.com/computerclubkec/computerclubkec.github.io/pull/61
  2. https://github.com/InDieTasten/ASCII-mate/pull/41
  3. https://github.com/bodonovan/wordle_cheat/pull/4
  4. https://github.com/jessesimpson36/yamldifftool/pull/5
  5. (other PRs) https://github.com/TheBaljitSingh/Apna-Blog-Frontend/pull/2, https://github.com/noskofficial/noskofficial.github.io/pull/79, https://github.com/One-Zero-Code/ngx-toastr-message/pull/19,
Blog Posts
  1. https://dev.to/mpalhutchinson/week-5-hacktoberfest-pull-request-1-5h64
  2. https://dev.to/mpalhutchinson/week-7-hacktoberfest-pull-request-2-5dh9
  3. https://dev.to/mpalhutchinson/week-8-hacktoberfest-pull-request-3-dn4
  4. https://dev.to/mpalhutchinson/week-9-hacktoberfest-pull-request-4-55al

ajogseneca - Ajo George

Issues
  1. Issue 1
  2. Issue 2
  3. Issue 3
  4. Issue 4
Pull Requests
  1. PR 1
  2. PR 2
  3. PR 3
  4. PR 4
Blog Posts

Tasbi03 - Tasbi Tasbi

Issues
Pull Requests
  1. Pull Request-1
  2. Pull Request-2
  3. Pull Request-3
  4. Pull Request-4
  5. Pull Request-5.1
  6. Pull Request-5.2
  7. Pull Request-5.3
Blog Posts
  1. Blog Post-1
  2. Blog Post-2
  3. Blog Post-3
  4. Blog Post-4
  5. Blog Post-5
  6. final Blog Post

MadhurSaluja - Madhur Saluja

Issues
  1. Issue 1
  2. Issue 2
  3. Issue 3
  4. Issue 4
Pull Requests
  1. Pull Request 1
  2. Pull Request 2
  3. Pull Request 3
  4. Pull Request 4
Blog Posts
  1. Blog 1
  2. Blog 2
  3. Blog 3
  4. Blog 4

vinhyan - Vinh Nhan

Issues
  1. Week 1 - Issue 1
  2. Week 2 - Issue 21
  3. Week 3 - Issue 328
  4. Week 4 - Issue 976
Pull Requests
  1. Week 1 - Pull Request 18
  2. Week 2 - Pull Request 22
  3. Week 3 - Pull Request 370
  4. Week 4 - Pull Request 985
Blog Posts
  1. Week 1 - Blog
  2. Week 2 - Blog
  3. Week 3 - Blog
  4. Week 4 - Blog

aamfahim - Abdullah Al Mamun Fahim

Issues
Pull Requests
Blog Posts

gitdevjin - Hyunjin Shin

Issues
Pull Requests
Blog Posts

Fahad-Ali-Khan-ca - Fahad ALi Khan

Issues

Pull Requests

Blog Posts

mayank-Pareek - Mayank Kumar

Issues
Pull Requests
Blog Posts

Rong Chen - Rong Chen

Issues
  1. Issue 1
  2. Issue 2
  3. Issue 2
Pull Requests
  1. Pull Request 1
  2. Pull Request 2
  3. Pull Request 3
Blog Posts
  1. Blog 1
  2. Blog 2
  3. Blog 3

InderParmar - Inderpreet Singh Parmar

Issues
Pull Requests
Blog Posts

mull028 - Amir Mullagaliev

Issues
Pull Requests
Blog Posts

KrinsKumar - Krinskumar Vaghasia

Issues
Pull Requests
Blog Posts