오픈 소스 프로젝트를 시작하기위한 체크리스트 [닫기] 문서 (사용자 외에), 기여

오픈 소스 프로젝트를 시작하는 것은 단지 일부 공공 저장소에서 소스 코드를 버리고 그에 만족하는 것이 아닙니다. 기술 문서 (사용자 외에), 기여 방법 등에 대한 정보가 있어야합니다.

해야 할 중요한 일에 대한 점검 목록을 만들면 무엇을 포함 하시겠습니까?



답변

가장 중요한 것은 :

  • 프로젝트를 직접 사용하고 사용하기 편리한 유용한 상태로 만드십시오. 프로젝트가 작동하고 유용하다는 것을 확인하십시오.

초기 우선 순위에 넣은 것은 다음과 같습니다.

  • 간단한 “무엇입니까?” 일부 토론 포럼 (이메일 또는 채팅)과 소스 코드 저장소에 대한 링크가있는 웹 사이트
  • 코드가 컴파일되고 일반적으로 작동하는지 확인하십시오. 다른 사람의 작업이 중단 될 수 있기 때문에 작업을 중단시키는 기본 분기에서 진행중인 작업 또는 절반 반의 패치를 커밋하지 마십시오.
  • 라이센스 파일을 잘 알려진 라이센스로 코드 저장소에 넣고 저작권 소유자 (아마도 귀하 또는 귀하의 회사)를 표시하십시오. 라이센스를 생략하거나 라이센스를 구성하거나 모호한 라이센스를 사용하지 마십시오.
  • 기여 방법에 대한 지침 (예 : HACKING 파일 또는 README에 포함)이 있습니다. 여기에는 패치를 보낼 위치, 패치를 포맷하는 방법, 코드 들여 쓰기 규칙, 프로젝트의 다른 중요한 규칙이 포함되어야합니다.
  • 버그를 신고하는 방법에 대한 지침이 있습니다
  • 메일 링리스트 나 포럼에 도움이 될 것

그 우선 순위 후에 나는 말할 것입니다 :

  • 문서화 (메일 링리스트 작업을 절약 할 수 있습니다 …리스트 게시물에서 FAQ를 작성하는 것은 간단한 시작입니다)
  • “정상적인”방식으로 일을 시도하십시오 (자신의 빌드 시스템을 발명하거나 이상한 것을 사용하지 마십시오 .1 공간 들여 쓰기를 사용하지 마십시오. 일반적으로 귀찮게 배우지 마십시오. 학습 곡선을 추가하기 때문입니다)
  • 프로젝트를 홍보하십시오. 마케팅 마케팅 마케팅. 블로그와 뉴스 사이트 및 이와 유사한 것들이 필요합니다. 그런 다음 사람들이 관심을 보이면 대화를 나누고 블로그가 작동하는지 확인하고 패치를 확인해야합니다. 관련 프로젝트에 대한 포럼에서 프로젝트를 언급 할 수도 있습니다.
  • 항상 가능한 빨리 패치를 검토하고 수락하십시오. 즉시 완벽합니다. 며칠 이상 당신은 많은 사람들을 잃고 있습니다.
  • 항상 가능한 한 빨리 프로젝트에 대한 이메일에 회신하십시오.
  • 환영 / 긍정적 / 재미있는 분위기를 조성하십시오. 바보가되지 마십시오. 감사합니다. 감사합니다. 모든 멍청이를 쫓아 내고 커뮤니티를 독살하기 시작합니다. 할 수있을 때 사람들을 직접 만나고 유대를 형성하십시오.

답변

초보자의 경우 진입 장벽을 낮추면 다음을 의미합니다.

  • 설치하기 쉽도록
  • 쉽게 수정하고
  • 프로젝트를 쉽게 찾을 수 있도록
  • 원하는 모든 것을 쉽게 만들 수 있습니다.

어떻게?

  • 문서에서 생각할 수있는 모든 질문에 답하십시오.
  • 사용하기 쉬운 빌드 시스템을 만들고
  • 스파게티 코드 작업을 좋아하는 사람은 없습니다.
  • 사람들이 필요로하는 것을 만드십시오.

답변