Ultralytics 오픈 소스 프로젝트 기여 시작을 위한 팁

오픈소스 소프트웨어의 근간은 협업, 학습, 공유에 있습니다. 오픈소스 프로젝트는 사람들이 모여 자신보다 더 큰 무언가를 함께 구축할 수 있는 훌륭한 방법입니다. Ultralytics는 오픈소스의 원칙을 매우 중요하게 생각하며, 여러분이 저희 오픈소스 프로젝트에 기여해주시는 것을 언제나 환영합니다.

문서 작성, 코드 리뷰, 이슈 해결 등 기여에 열정을 가지고 있지만 어디서부터 시작해야 할지 모르거나 issues에 직면해 있는 분들을 위해 저희가 도와드리겠습니다. 본 글에서는 Ultralytics 오픈소스 프로젝트 기여를 시작하기 위한 몇 가지 팁을 안내해 드립니다. 바로 시작하겠습니다!

Ultralytics 커뮤니티 기여의 중요성#

기여 방법에 대해 알아보기 전에, 왜 기여가 그토록 중요한지 그 이유를 살펴보겠습니다. 저희는 Ultralytics 커뮤니티의 기여가 가지는 중요성을 굳게 믿고 있습니다. 오픈소스 프로젝트에 참여하는 것은 단순히 더 나은 소프트웨어를 만드는 데 도움을 주는 것 이상의 의미를 갖습니다. 기여자는 당사의 기술이 개방적이고 협력적이며 끊임없이 발전하도록 유지하는 데 핵심적인 역할을 합니다. 여러분의 기여는 프로젝트가 번창하고, accessible하며, 전 세계의 사용자 및 개발자에게 유익하도록 만듭니다!

최첨단 소프트웨어를 개발하는 것을 넘어, Ultralytics 프로젝트에 기여하는 것은 여러분이 성장할 수 있는 환상적인 기회이기도 합니다. 숙련된 개발자들과 함께 일하며 안내를 받고 모범 사례를 공유함으로써 코딩, 문제 해결, 팀워크 능력을 기를 수 있습니다. 여러분의 노력은 전 세계 수천 명의 사람들이 사용하는 도구에 실질적인 영향을 미칠 수 있습니다. 커뮤니티와 교류하면 전문적인 네트워크를 확장하고 새로운 기회를 창출하며, 고용주에게 돋보일 수 있도록 포트폴리오를 향상하는 데도 도움이 됩니다.

그림 1. 기여해야 하는 이유. 이미지 제공: 저자.

Ultralytics 오픈소스 기여 시작하기#

시작하기 좋은 방법은 official Ultralytics contributing guide를 확인하는 것입니다. 여기에는 기여를 최대한 활용하는 데 도움이 되는 모범 사례와 팁이 가득합니다. 첫 번째 단계는 contributing guidelines를 숙지하고 코드를 살펴보며 프로젝트의 기존 구성 요소를 파악하는 것입니다.

개발에 기여하고자 하거나 최신 코드를 탐색하고 싶다면, 다음 단계는 clone the Ultralytics repository입니다. 완료되면 프로젝트 디렉터리로 이동하여 아래 코드 스니펫과 같이 패키지를 편집 가능한 모드로 설치할 수 있습니다.

도움이 필요하다면 our quickstart guide에 원활한 시작을 위해 필요한 모든 것이 담겨 있습니다.

다양한 기여 분야#

환경을 설정하고 프로젝트에 익숙해졌다면, 의미 있는 변화를 만들 수 있는 다양한 영역을 탐색해 보세요. Ultralytics는 참여할 수 있는 여러 방법을 제공하며, 여러분의 기술과 관심사에 따라 기여 방식을 선택할 수 있습니다.

몇 가지 옵션은 다음과 같습니다:

• Documentation: 문서화 기여는 작문 실력을 다지는 동시에 프로젝트에 깊이 관여할 수 있는 훌륭한 방법입니다. 기존 문서를 개선하고, 누락된 세부 정보를 추가하거나, 다른 사람들이 더 쉽게 기여할 수 있도록 새로운 가이드를 작성하는 등의 도움을 줄 수 있습니다.
• Bug fixes: 코딩 경험이 있다면 버그 수정 작업을 고려해 보세요. 사소한 조정부터 더 복잡한 문제까지 다양하며, 프로젝트에 실질적인 영향을 미칠 수 있는 기회를 제공합니다.
• Feature enhancements: 더 깊이 파고들 준비가 된 분들에게는 기능 개선 작업이 도전적이면서도 보람될 수 있습니다. 여기에는 새로운 기능 추가, 기존 기능 개선 또는 프로젝트 로드맵 작업이 포함될 수 있습니다.
• Pull request reviews: 풀 리퀘스트 리뷰는 특히 프로젝트의 표준과 모범 사례에 익숙한 경우 기여할 수 있는 또 다른 가치 있는 방법입니다. 피드백을 제공하고 개선 사항을 제안함으로써 코드베이스의 품질과 무결성을 유지하는 데 도움을 줄 수 있습니다.
• Community discussions: 커뮤니티 토론 참여는 협업과 아이디어 공유를 즐기는 경우 기여할 수 있는 훌륭한 방법입니다. 진행 중인 대화에 참여하고, 새로운 아이디어를 제안하거나, 통찰력과 솔루션을 제공하여 다른 사람을 도울 수 있습니다.

이러한 각 영역은 고유한 기여 방법을 제공하며, 여러분의 강점과 관심사에 가장 잘 맞는 것을 선택할 수 있습니다. 아무리 작은 기여라도 Ultralytics가 성장하고 발전하는 데 중요한 역할을 한다는 점을 기억해 주세요.

그림 2. 성장하는 커뮤니티에서 모든 기여는 소중합니다. 이미지 출처: Envato Elements.

Ultralytics 오픈소스 문서 기여하기#

Ultralytics 문서에 기여할 때는 기존 문서를 검토하고 개선이 필요한 부분을 강조하는 이슈나 토론이 있는지 확인하십시오. 이렇게 하면 가장 필요한 부분에 집중하여 기여할 수 있습니다.

작성하거나 편집할 때 일관성을 유지하기 위해 프로젝트 지침을 따르는 것이 핵심임을 명심하세요. 몇 가지 서식 팁은 다음과 같습니다:

• 항상 Markdown formatting을 사용하세요.
• 각 문서는 명확한 도입부로 시작하고, 언어는 단순하고 이해하기 쉽게 작성하세요.
• 목록에는 글머리 기호를 사용하고, 링크에는 설명적인 텍스트를 사용하며, 페이지가 빠르게 로드되도록 이미지 용량은 1MB 미만으로 유지하세요.
• 서식에 대해 궁금한 점이 있다면, 이전 문서들이 어떻게 작성되었는지 확인해보는 것이 서식을 다시 점검하는 쉬운 방법입니다.

그림 3. Markdown 서식 예시(왼쪽)와 최종 시각화 문서(오른쪽). 이미지 제공: 저자.

초안을 작성한 후에는 문서를 로컬에서 빌드하여 미리 보는 것이 중요합니다. 제출하기 전에 문제를 포착할 수 있습니다. 이를 위해서는 저장소를 클론하고 프로젝트 디렉토리로 이동하여 시작하세요:

다음으로 필요한 종속성을 설치할 수 있습니다:

마지막으로 변경 사항을 검토하기 위해 문서를 로컬에서 서빙하세요:

웹 브라우저에서 http://127.0.0.1:8000/(으)로 이동하여 로컬에서 빌드된 문서를 확인할 수 있습니다.

명확성, 정확성, 일관성을 검토한 후, 작성한 문서에 대한 명확한 설명과 함께 풀 리퀘스트를 제출할 수 있습니다. 가장 적합하고 알맞은 위치를 기준으로 적절한 섹션에 문서를 배치해야 합니다(guides, solutions, integrations 등). 또한 관련 섹션에 대한 index.md 파일과 전체 mkdocs.yml 파일을 확인하고 필요에 따라 업데이트를 진행해 주세요. 세부 사항에 주의를 기울이면 검토 과정이 원활하게 진행되고 기여 내용이 프로젝트에 잘 통합되는 데 도움이 됩니다.

오픈소스 코드 기여 시 유의 사항#

Ultralytics 프로젝트에 코드를 기여할 때는 코드가 깔끔하고 유지보수가 쉬우며 통합이 용이하도록 모범 사례를 따르는 것이 중요합니다. 유의해야 할 주요 사항은 다음과 같습니다:

• 코드 중복 방지: 가능한 한 기존 코드를 재사용하고 불필요한 인수를 최소화하세요.
• 더 작고 집중된 변경: 대규모 수정보다는 작고 타겟이 명확한 변경에 집중하세요.
• 코드 단순화 또는 제거: 코드를 단순화하거나 불필요한 부분을 제거할 기회를 찾으세요.
• Write effective docstrings: 코드가 수행하는 작업을 명확하게 설명하고 관련 리소스를 연결하세요.
• 불필요한 종속성 방지: 반드시 필요한 경우에만 종속성을 추가하세요.

Fig 4. 소스 코드 문서화 모범 사례.

코드베이스의 장기적인 유지보수 가능성을 고려하는 것도 필수적입니다. 변경을 수행하기 전에 수정 사항이 Ultralytics를 사용하는 다른 사람의 기존 코드를 깨뜨릴 수 있는지 스스로 질문해보세요. 만약 그렇다면 이를 해결할 방법을 고민하고 변경 사항이 최대한 호환되도록 하세요.

기여할 코드를 개발했다면 테스트를 거쳐야 합니다. 제출하기 전에 pytest와 같은 프레임워크를 사용하여 변경 사항을 테스트할 수 있습니다. 일관된 코드 포맷팅은 기여의 매우 중요한 또 다른 측면입니다. Ruff Formatter와 같은 도구는 스타일의 일관성을 유지하고 코드의 논리적 버그나 불일치를 감지하는 데 도움을 줍니다.

풀 리퀘스트 리뷰하기#

풀 리퀘스트(PR)를 리뷰하는 것은 훌륭한 기여 방법입니다! PR은 누군가가 자신의 변경 사항을 메인 프로젝트에 병합해달라고 요청할 때 생성됩니다. 이는 Ultralytics 프로젝트가 원활하게 운영되도록 돕습니다. PR을 리뷰할 때는 변경이 왜 이루어졌는지 이해해야 합니다. 작성자는 업데이트의 목적과 이점을 명확히 설명해야 하며, PR에서 철저한 테스트 증거를 볼 수 있어야 합니다.

Fig 5. 풀 리퀘스트란 무엇인가요?

주로 집중해야 할 몇 가지 핵심 사항을 살펴보겠습니다.

• 단위 테스트 확인: PR에 새로운 기능이나 변경 사항에 대한 테스트가 포함되어 있는지 확인하여 코드가 예상대로 작동하고 문제를 일으키지 않는지 확인하세요.
• 문서 업데이트 리뷰: 예제, API 참조 및 기타 관련 세부 정보를 포함하여 변경 사항이나 새로운 기능을 반영하도록 문서가 업데이트되었는지 검증하세요.
• 성능 영향 평가: 변경 사항이 성능에 미치는 영향을 고려하세요. 필요한 경우 성능 벤치마크나 추가 테스트를 요청하세요.
• Verify CI tests: 코드 포맷팅 및 단위 테스트 결과 검사를 포함하여 모든 Continuous Integration (CI) 테스트가 통과하는지 확인하세요.
• 수정사항에 대한 협업: 테스트가 실패하면 작성자와 협력하여 PR을 승인하기 전에 문제를 해결하세요.

리뷰어로서 이슈나 우려 사항에 대해 구체적이고 명확한 피드백을 제공하세요. 개선을 위한 제안을 하고 작성자가 잠재적인 문제를 생각해보도록 질문하세요. 코딩, 테스트, 문서화 모범 사례를 따르도록 격려하고, 도움이 될 리소스를 기꺼이 알려주세요. 마지막으로, 작성자가 PR을 위해 기울인 노력에 항상 감사를 표하세요. 긍정적인 피드백은 오픈소스 커뮤니티의 친절하고 협력적인 분위기를 유지하는 데 도움이 됩니다.

기여는 커뮤니티에 관한 모든 것입니다#

Ultralytics와 같은 오픈소스 프로젝트에 기여하면 영감을 주는 커뮤니티 소속감을 느낄 수 있습니다. 코드를 작성하든, PR을 리뷰하든, 문서를 업데이트하든, 토론에 참여하든 모든 노력이 프로젝트의 성장과 발전에 도움이 됩니다. GitHub, Discord, Subreddit 또는 기타 포럼에서 이슈에 답변하거나 대화에 참여하는 것은 기여하고 다른 사람들과 소통할 수 있는 가치 있는 방법입니다. 작더라도 여러분의 기여는 큰 영향을 미치며, 관련된 모든 사람을 위해 협력적이고 지지적인 환경을 조성하는 데 도움이 된다는 점을 기억하세요!

Ultralytics는 오픈소스 커뮤니티의 혁신을 주도하는 데 열정을 쏟고 있습니다. GitHub repository를 방문하여 최신 개발 소식을 받아보세요. our vibrant community에 가입하여 agriculture 및 manufacturing과 같은 산업 전반에 당사가 어떤 영향을 미치고 있는지 확인해 보세요.