오픈 소스 개발자로서 Slack과 협업

소개

더 많은 경험을 쌓고 싶은데 어디서부터 시작해야 할지 고민하고 있는 초보 개발자이신가요? 이 블로그 게시물은 당신을 위한 것입니다!

기술을 쌓는 가장 좋은 방법 중 하나는 오픈 소스 프로젝트에 기여하는 것입니다. 최근 저는 SlackAPI GitHub Repo에서 문제를 해결했습니다. 이 글을 쓰는 시점에 관리자 중 한 명이 내 PR(풀 요청)을 수락했으며 모든 CI 빌드를 통과하고 방금 병합되었습니다!?

이 게시물에서는 이 문제를 해결하는 과정, 직면한 어려움, 그 과정에서 배운 교훈을 공유하겠습니다.

문제

제가 작업한 문제는 Slack API의 URL 처리에 관한 것이었습니다. 특히 코드는 base_url이 누락된 경우 후행 슬래시(/)를 추가하지 않았으며 이로 인해 API 호출이 일관되지 않거나 실패할 수 있었습니다.

예:

• 후행 슬래시 제외: https://slack.com/api
• 후행 슬래시 포함: https://slack.com/api/

후행 슬래시 누락으로 인해 신뢰성을 보장하기 위해 해결해야 하는 미묘한 문제가 발생했습니다. 제 목표는 슬래시가 제공되지 않은 경우 슬래시가 자동으로 추가되도록 코드를 수정하는 것이었습니다.

원본은 여기에서 찾을 수 있습니다: #1541.

도전과제

편집할 올바른 파일 찾기

대규모 코드베이스를 다루는 초보자로서 첫 번째 과제는 변경 사항을 적용할 위치를 찾는 것이었습니다. 익숙하지 않은 디렉토리를 탐색하고 프로젝트 구조를 이해하는 데는 시간이 걸렸습니다. 문서를 읽고 코드를 단계별로 살펴보니 관련 파일을 찾는 데 도움이 되었습니다.

수정 사항 작성

파일(base_client.py)을 식별한 후 base_url이 /로 끝나도록 하는 솔루션 초안을 작성했습니다. 그러나 이를 구현하기 전에 관리자에게 연락하여 지침을 구했습니다. 그들은 비슷한 논리가 async_base_client.py와 Legacy_base_client.py라는 두 개의 다른 파일에도 적용되어야 한다고 지적했습니다. 이는 협업 프로젝트에서 명확한 의사소통과 사전 논의의 중요성을 일깨워주는 훌륭한 사례였습니다.

뒤에 슬래시를 추가하기 위해 업데이트된 코드 조각은 다음과 같습니다.

if not base_url.endswith("/"):
    base_url += "/"

이 간단한 변경을 통해 모든 API 호출이 일관된 기본 URL을 사용하게 되었습니다. 이 논리를 다른 두 파일에도 복제하여 여러 클라이언트에서 일관성을 유지했습니다.

테스트 추가

테스트는 이번 수정에서 중요한 부분이었습니다. 후행 슬래시가 누락된 경우 base_url이 수정되었는지 확인하기 위해 test_web_client.py 파일에 새 테스트를 추가했습니다. 예:

• 입력: http://localhost:8888
• 예상 출력: http://localhost:8888/

다음은 제가 추가한 테스트 중 하나를 단순화한 버전입니다.

if not base_url.endswith("/"):
    base_url += "/"

테이크아웃

테스트의 중요성

PR을 제출하기 전에 변경 사항을 철저히 테스트하세요. 단위 테스트 작성, 기존 테스트 실행, 디버깅 도구 사용은 코드가 예상대로 작동하는지 확인하는 데 중요한 단계입니다. 극단적인 경우에 대한 테스트를 자동화하면 잠재적인 오류를 조기에 포착하고 솔루션에 대한 신뢰도를 높일 수 있습니다.

기여 지침을 따르세요

모든 오픈소스 프로젝트에는 고유한 기여 지침이 있습니다. 코딩 표준, 테스트 요구 사항 및 PR 제출 프로세스가 설명되어 있으므로 주의 깊게 읽고 따르십시오. 예를 들어 SlackAPI는 개발 환경 설정 및 테스트 실행에 대한 명확한 지침을 제공했습니다.

의사소통이 핵심이다

변경 사항을 관리자와 사전에 논의하면 시간을 절약하고 불필요한 앞뒤 작업을 방지할 수 있습니다. 제 경우에는 모든 관련 파일에 수정 사항을 적용하여 솔루션을 더욱 포괄적으로 만들었습니다.
도움 요청을 두려워하지 마세요

막히는 부분이 있으면 주저하지 말고 질문하세요. 오픈 소스 관리자와 기여자는 종종 새로운 사용자를 지원하고 기꺼이 도와줍니다.

최종 생각

오픈소스에 기여하는 것은 처음에는 겁이 날 수 있지만 개발자로서 성장하는 가장 좋은 방법 중 하나입니다. 팀으로 작업하고, 대규모 코드베이스를 탐색하고, 프로덕션에 바로 사용할 수 있는 코드를 작성하는 방법을 배우게 됩니다. 게다가, 여러분의 작업이 다른 사람들에게 사용되는 것을 보면 정말 기분이 좋습니다!

초보 개발자라면 오픈 소스 프로젝트를 탐색하고 관심 있는 문제를 찾아 도전해 보시기 바랍니다. SlackAPI GitHub Repo는 시작하기에 좋은 장소입니다!

오픈소스 프로젝트에 기여한 적이 있나요? 아래 댓글로 여러분의 경험을 공유해 주세요! ?

위 내용은 오픈 소스 개발자로서 Slack과 협업의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!