Skip to content

Commit 7faec60

Browse files
authored
Merge pull request #20 from vaibhavyxx/main
Contribution 1: First Contribution
2 parents 6b9d437 + 95831fc commit 7faec60

File tree

6 files changed

+138
-0
lines changed

6 files changed

+138
-0
lines changed

.github/workflows/jekyll.yml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
7+
name: Deploy Jekyll site to Pages
8+
9+
on:
10+
# Runs on pushes targeting the default branch
11+
push:
12+
branches: ["main"]
13+
14+
# Allows you to run this workflow manually from the Actions tab
15+
workflow_dispatch:
16+
17+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
18+
permissions:
19+
contents: read
20+
pages: write
21+
id-token: write
22+
23+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
24+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
25+
concurrency:
26+
group: "pages"
27+
cancel-in-progress: false
28+
29+
jobs:
30+
# Build job
31+
build:
32+
runs-on: ubuntu-latest
33+
steps:
34+
- name: Checkout
35+
uses: actions/checkout@v4
36+
- name: Setup Ruby
37+
# https://github.com/ruby/setup-ruby/releases/tag/v1.207.0
38+
uses: ruby/setup-ruby@4a9ddd6f338a97768b8006bf671dfbad383215f4
39+
with:
40+
ruby-version: '3.1' # Not needed with a .ruby-version file
41+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
42+
cache-version: 0 # Increment this number if you need to re-download cached gems
43+
- name: Setup Pages
44+
id: pages
45+
uses: actions/configure-pages@v5
46+
- name: Build with Jekyll
47+
# Outputs to the './_site' directory by default
48+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
49+
env:
50+
JEKYLL_ENV: production
51+
- name: Upload artifact
52+
# Automatically uploads an artifact from the './_site' directory by default
53+
uses: actions/upload-pages-artifact@v3
54+
55+
# Deployment job
56+
deploy:
57+
environment:
58+
name: github-pages
59+
url: ${{ steps.deployment.outputs.page_url }}
60+
runs-on: ubuntu-latest
61+
needs: build
62+
steps:
63+
- name: Deploy to GitHub Pages
64+
id: deployment
65+
uses: actions/deploy-pages@v4

_posts/2025-04-06-contributions-1.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
layout: post
3+
# If your post title is longer or more complicated
4+
# than can be represented in the filename, uncomment the following line
5+
# and specify a custom title
6+
title: "Contribution 1: First-Contributions"
7+
8+
categories:
9+
- Contribution
10+
11+
# Enter your name below
12+
author: Vaibhavy Darshan
13+
---
14+
# My Open Source Contribution Experience
15+
16+
## Choosing a Community
17+
Choosing a community was the hardest part. I did not know enough about the open source ecosystem to confidently choose where to contribute. It felt daunting—more like walking into the unknown—so I focused on documentation as a starting point. Hence, most of the communities that I prefered were first good-first-issue or required simple fixes.
18+
19+
## Communities I Considered
20+
21+
- **[Arduino Docs](https://github.com/arduino/docs-content)**
22+
I use Arduino frequently enough to understand how it works. However, I wasn’t able to locate the specific page with the bug. Additionally, it was written in Markdown, but not in a format I was comfortable working with.
23+
![typo discussion](https://github.com/vaibhavyxx/hfoss2025-blogs/blob/main/assets/images/contributions-1/arduino-docs-content.png?raw=true)
24+
I earlier commented on it but I ended up deleting as I could not figure it out.
25+
26+
- **[Twine](https://github.com/klembot/twinejs)**
27+
The bug seemed simple enough to fix, but it was an old issue. I couldn’t find it and tried contacting others to check if it was still relevant or accessible.
28+
![favicon issue]()
29+
30+
- **[FreeSoundOrg](https://github.com/MTG/freesound)**
31+
The issue was really interesting, but also quite complex for a first contribution. I might revisit this in the future.
32+
![dynamic css suggestion](https://github.com/vaibhavyxx/hfoss2025-blogs/blob/main/assets/images/contributions-1/freesound.png?raw=true)
33+
34+
- **[Awesome Audio Visualization](https://github.com/willianjusten/awesome-audio-visualization/issues)**
35+
The repository had a lot of outdated links, which seemed like a simple fix. However, the repository has been inactive for a few years, so I was hesitant to work on it.
36+
37+
## What Did I Pick?
38+
39+
I ultimately decided to contribute to the **[first-contributions](https://github.com/firstcontributions/first-contributions)** repository on GitHub, which is aimed at teaching beginners how to make their first contributions.
40+
41+
I found this repository through class resources. There was a bug regarding confusing instructions, which made for an easy fix and gave me the opportunity to learn how to send my first Pull Request (PR). So, I needed to edit the [ReadMe](https://github.com/firstcontributions/first-contributions/blob/main/README.md).
42+
43+
## How Did My Comm Arch Experience Help?
44+
45+
Honestly, my Comm Arch experience wasn’t directly helpful in picking this repository. The ones we discussed in class required deeper familiarity with the software or the codebase. I ended up asking the TA for help and looking through class resources for support.
46+
47+
## Contribution.md?
48+
49+
The `CONTRIBUTING.md` file in the first-contributions repository made the process much easier. It clearly explained how to make changes and submit a PR.
50+
51+
## Issue I Fixed
52+
53+
There were conflicting instructions between GitHub Desktop and the `README.md`. GitHub Desktop told users to place their names at the end of the list, so I updated the `README.md` to match that instruction. I found that through an issue mentioned [here](https://github.com/firstcontributions/first-contributions/issues/96053).
54+
55+
![Issue](https://github.com/vaibhavyxx/hfoss2025-blogs/blob/main/assets/images/contributions-1/first-contribution-issue.png?raw=true)
56+
Feel free to click [here](https://github.com/firstcontributions/first-contributions/pull/96227) to take a look at my PR.
57+
![Screenshot of my Pull Request](https://github.com/vaibhavyxx/hfoss2025-blogs/blob/main/assets/images/contributions-1/first-contributions.png?raw=true)
58+
59+
## My Failed Contribution
60+
61+
I attempted to contribute to the FreeSoundOrg website by removing duplicate CSS imports to improve loading time. However, even though the site used JavaScript (which I am somewhat familiar with), I didn’t feel confident enough with the overall codebase to proceed. I did, however, look at tutorials to see if I could potentially fix it.
62+
63+
## What Blocked Me?
64+
65+
- **FreeSound.Org** – My limited technical knowledge.
66+
- **First-Contributions** – I initially didn’t know how to refer my PR to the issue another user pointed out, but after some online research, I figured it out.
67+
68+
## Was I Successful?
69+
70+
Technically, my PR hasn’t been accepted or declined yet, so I can’t say for sure. But personally, yes—I was successful. At first, I felt I wouldn’t be able to do this assignment due to lack of knowledge and fear of contributing to an unfamiliar community. But I overcame that fear and made sure my commits and PR were clear and direct.
71+
72+
73+
Loading
Loading
Loading
100 KB
Loading

0 commit comments

Comments
 (0)