헤이 초보자,
오픈 소스로 나아가는 것을 축하합니다. 그것은 훌륭한 공동체입니다.
시작 부분에서 약간 혼란 스럽습니다. 기여하는 방법,기여하는 곳,문제,버그,홍보,홍보,홍보!
걱정하지 마세요,당신은 자신이 모든 것을 배울 수 있습니다 오픈 소스에 참여 얻을로.그러나 오늘 저는 오픈 소스 여행을 시작했을 때 결코받지 못한 몇 가지 조언을 여러분에게 전하고 싶습니다.
저는 오픈 소스에 기여하고 얼마 전에 모든 작은 사이드 프로젝트를 GitHub 에 넣기 시작했습니다., 그 당시에는 README 부분에 대해 알지 못했습니다. 시간이 지났고 일부 kickass 개발자를 따라 가기 시작했습니다. 그들은 의심의 여지가 모두가 놀라운 프로젝트 그러나 대부분의 일반적인 일이었고,그들의 모든 프로젝트던 멋진 추가 정보는 어떻게 나왔을의 중요성에 대해 알고 좋은 추가 정보.
그만!! 나는 당신의 오픈 소스 여행에 대해 읽는 것에 관심이 없다. 그냥 좋은 README 를 작성하는 방법에 대해 말해.
쿨. 그래서 여기에 당신이 갈—
을 시작하기 전에 넣어 당신의 멋진 프로젝트에 GitHub,나는 당신을 읽어에 대해 읽어보기 구동 발전 처음이다.,추가 정보를 신경 써야하는 이유는 무엇입니까?
오픈 소스 커뮤니티는 빠르게 성장하고 있습니다. 개발자는 매일 GitHub 에서 새로운 오픈 소스 프로젝트를 출시합니다. 결과적으로,그것은 점점 더 어려워지고 자신을 얻기 위해 프로젝트에서 눈에 띄는 바다의 오픈 소스 소프트웨어입니다. 그러나 다른 개발자의 관심을 사로 잡을 가능성을 높이기 위해 몇 가지 작업을 수행 할 수 있습니다. 효과적이고 간단한 기술 중 하나는 멋지게 보이고 도움이되는 README 파일을 올리는 것입니다.
귀하의 README 는 프로젝트만큼 훌륭해야합니다., 훌륭한 README 파일은 프로젝트가 github 의 오픈 소스 소프트웨어의 바다에서 눈에 띄는 데 도움이됩니다.
README 는 프로젝트의 얼굴과 같습니다. 그것은 첫 번째 파일을 사람이 읽어야 할 경우가 발생하는 소스 트리,그리고 그것으로 작성되어야하는 매우 짧고 매우 기본적인 소개를 소프트웨어입니다.
README 가없는 프로젝트는 그다지 유용하지 않습니다. 예를 들어이 프로젝트를 살펴 보겠습니다.
추가 정보 없음,설명 없음,아무 것도 없습니다. 이 사람이 얼마나 멋진 지간에 어떤 아이디어도받지 못할 것입니다.,
이제이 프로젝트를 살펴 보겠습니다. 저자는 프로젝트에 대한 상세하고 명확한 지침을 언급 했으므로 다른 사람들이 사용하고 시험해 보는 것이 더 쉽습니다.나는 이것이 내가하고있는 일이 아니라는 것을 알고 싶다. 프로젝트와 좋은 추가 정보고 스크린 샷을 얻을 것이 사용자의 관심은 더 나은 이후 그것의 직접적인 방법을 설명 왜 이 프로젝트 문제,그리고 사람들이 사용해야에 기여하는 프로젝트입니다. 좋은 README 에는 새로운 사용자가 시작하는 데 도움이되는 충분한 세부 정보도 포함되어야합니다(예:, 컴파일 방법,설치 방법 및 통합을 시작하는 방법.
Ok. 충분한 이야기. 다음 좋은 README 를 작성하는 방법을 보여줍니다.
이제 README 가 중요하다는 데 동의하면서 하나를 작성하는 방법을 알려 드리겠습니다. 그렇게 어렵지 않습니다. 당신은 단지 몇 가지 총알 포인트를 고수해야합니다. 다음은 읽어보기를 작성하는 동안 명심해야 할 몇 가지 사항입니다.
의 포맷 추가 정보?,
이제 README 에서 작성하는 방법과 내용을 가르쳐 주었으므로 readme 일명 서식의 스타일링에 대해 조금 이야기하겠습니다.
서식은 README 의 필수적인 부분입니다. 여기와 여기에서 README 를 포맷하는 방법에 대해 배울 수 있습니다.
에서 종료,염두에 두—
할 필요가 없는 전체 구멍 읽어보기 중심의 개발,당신은 포함하지 않아도 모든 사람들이 총알 지점,당신은 당신이 필요하지 않을 따라 어떠한 특정한 과정입니다. 그러나 좋은 읽어보기를 작성하면 문서 기술이 확실히 향상되어 더 나은 개발자가 될 것입니다.,나는 이것을 할 수 없다.
Leave a Reply