클래스 레포에 기여하기

소개

이전에 Seneca에서 수강한 과정 중 하나인 IPC144는 웹사이트를 대대적으로 개편하고 있으며 오픈 소스 수업을 통해 이 프로젝트에 기여할 기회를 가졌습니다. 업데이트해야 할 모든 페이지가 있는 거대한meta issue 페이지가 있었고 arrays.md 페이지를 감사하고 수정하는 작업을 맡기로 결정했습니다.

작업 접근

issue 을 살펴보면 완성해야 할 항목 목록이 상당히 많았습니다. 먼저 이슈를 분기하고 복제하고 내 이슈에 대한 새 분기(issue-40이라고 함)를 만들고 웹 사이트를 시작하여 어떻게 보이는지 확인했습니다. 그런 다음 목록을 하나씩 처리하고 완료한 작업을 확인하고 각 작업에 대한 커밋을 생성했습니다.

내가 변경한 사항 중 일부는 다음과 같습니다.

오타 수정

사이트 내 링크 추가 및 링크에 설명 텍스트 추가

Frontmatter 추가

---
id: arrays
title: "Arrays"
sidebar_position: 1
slug: /data-structures/arrays
description: "An array is a data structure consisting of an ordered set of elements of common type that are stored contiguously in memory."
---

구문 강조 표시 추가

콘솔 오류를 일으키는 일부 HTML 수정

예를 들어 HTML 테이블에는 <thead> 오류를 유발하는 <tbody> 또는 <tr> cannot appear as a child of <table> 태그가 없었고 열은 colSpan 대신 colspan을 사용했습니다.

이 모든 변경 사항을 issue-40 브랜치에 푸시하고 메인 리포지토리에 풀 리퀘스트를 생성했습니다.

리뷰 받기

풀 리퀘스트에 유용한 리뷰를 많이 받았습니다. 예를 들어 페이지의 이미지는 다크 모드에서 보기 어려웠고 대체 텍스트를 추가하는 것을 잊었습니다. 제 동급생 중 두 명Tengzhen과 Minsu이 이를 지적했고 Tengzhen은 이미지를 저장하고 흰색 배경을 추가하여 검은색 텍스트가 검은색 배경에 계속 표시되도록 할 것을 제안했습니다.



이전 이미지는 이런 모습입니다. 보시다시피 다크 모드에서는 원으로 표시된 텍스트가 거의 보이지 않습니다.



수정 후 더 명확해졌습니다.

Jerry은 테이블이 모든 화면 크기에서 잘 보이지 않고 그의 경우 전체 테이블을 보려면 스크롤해야 하므로 테이블을 이미지로 변환할 수 있다고 제안했습니다.



이것은 테이블이 Jerry를 찾는 방법입니다.



수정 후 모든 테이블은 이미지이며 페이지 크기에 따라 크기가 조정됩니다.

마지막으로 Kien님이 해당 페이지의 오타와 broken link을 지적해 주셨습니다.

결론

풀 리퀘스트를 만들기 전에 제 작업을 확인했지만, 오픈 소스의 좋은 점은 놓친 부분이 있더라도 다른 사람들로부터 많은 좋은 의견을 얻을 수 있고 더 나은 방법에 대한 제안을 얻을 수 있다는 것입니다. 모든 사람이 동일한 작업에 접근하는 방식이 다르기 때문에 이렇게 큰 메타 문제에 대해 작업하는 것은 약간 압도적이었지만, 훌륭한 학습 경험이었고 오픈 소스 커뮤니티와 함께 ​​작업하는 것에 대해 매우 감사하게 만들었습니다.