코딩 스타터 프로젝트
스타터 프로젝트를 다른 사람들과 공유하고 성장하는 데 도움이되는 기본 저장소!
우선, 시간을내어 기여해 주셔서 감사합니다!
모든 유형의 기여는 권장되고 평가됩니다. 다양한 방법 과이 프로젝트를 처리하는 방법에 대한 세부 사항은 목차 테이블을 참조하십시오. 기여하기 전에 관련 섹션을 읽으십시오. 그것은 우리가 유지 관리자에게 훨씬 쉽게 만들고 모든 관련자들에 대한 경험을 원활하게 만들 것입니다. 커뮤니티는 귀하의 기여를 기대합니다.
그리고 프로젝트를 좋아하지만 기여할 시간이 없다면 괜찮습니다. 프로젝트를 지원하고 감사를 표하는 다른 쉬운 방법이 있습니다. 우리는 또한 매우 기뻐할 것입니다.
- 프로젝트를 시작하십시오
- 그것에 대해 트윗하십시오
- 이 프로젝트를 프로젝트의 readme에서 참조하십시오
- 지역 모임에서 프로젝트를 언급하고 친구/동료들에게 이야기하십시오.
목차
- 행동 강령
- 질문이 있습니다
- 나는 기여하고 싶다
- 보고 버그
- 개선 제안
행동 강령
이 프로젝트와 그에 참여하는 모든 사람들은 기고금 .md 행동 강령에 의해 적용됩니다. 참여 함으로써이 코드를지지해야합니다. 용납 할 수없는 행동을 <> 에보 고하십시오.
질문이 있습니다
질문을하고 싶다면 사용 가능한 문서를 읽었다고 가정합니다.
질문을하기 전에 도움이 될만한 기존 문제를 검색하는 것이 가장 좋습니다. 적절한 문제를 발견했지만 여전히 설명이 필요한 경우이 문제에 질문을 작성할 수 있습니다. 또한 인터넷을 검색하여 답변을 먼저 검색하는 것이 좋습니다.
그래도 여전히 질문을하고 설명이 필요하다고 생각되면 다음을 권장합니다.
- 문제를여십시오.
- 당신이 달리는 것에 대해 가능한 많은 맥락을 제공하십시오.
- 관련성이있는 것에 따라 프로젝트 및 플랫폼 버전 (Nodejs, NPM 등)을 제공하십시오.
그런 다음 가능한 빨리 문제를 처리합니다.
나는 기여하고 싶다
법적 통지
이 프로젝트에 기여할 때는 컨텐츠의 100%, 콘텐츠에 필요한 권한이 있고 귀하가 기부 한 콘텐츠가 프로젝트 라이센스에 따라 제공 될 수 있다는 데 동의해야합니다.
보고 버그
버그 보고서를 제출하기 전에
좋은 버그 보고서는 다른 사람들이 더 많은 정보를 얻기 위해 당신을 쫓아 내야하지 않아야합니다. 따라서 신중하게 조사하고 정보를 수집하며 문제를 보고서에 자세히 설명하도록 요청합니다. 잠재적 인 버그를 최대한 빨리 수정할 수 있도록 다음 단계를 미리 완료하십시오.
- 최신 버전을 사용하고 있는지 확인하십시오.
- 호환되지 않는 환경 구성 요소/버전을 사용하여 버그가 실제로 버그인지 버그인지에 대한 오류가 아닌지 확인하십시오 (문서를 읽은지 확인하십시오. 지원을 찾고 있다면이 섹션을 확인할 수 있습니다).
- 다른 사용자가 귀하와 동일한 문제를 경험 한 (그리고 잠재적으로 이미 해결했는지 확인하려면 버그 추적기에 버그 또는 오류에 대한 버그 보고서가 없는지 확인하십시오.
- 또한 GitHub 커뮤니티 외부의 사용자 가이 문제에 대해 논의했는지 확인하려면 인터넷 (스택 오버플로 포함)을 검색하십시오.
- 버그에 대한 정보 수집 :
- 스택 트레이스 (트레이스 백)
- OS, 플랫폼 및 버전 (Windows, Linux, MacOS, X86, ARM)
- 관련성에 따라 통역사, 컴파일러, SDK, 런타임 환경, 패키지 관리자의 버전.
- 아마도 당신의 입력과 출력
- 문제를 안정적으로 재현 할 수 있습니까? 그리고 오래된 버전으로 재생할 수 있습니까?
좋은 버그 보고서를 어떻게 제출합니까?
민감한 정보를 포함한 보안 관련 문제, 취약점 또는 버그를 문제 추적기 또는 다른 곳에서보고하지 않아야합니다. 대신에 민감한 버그는 이메일로 <>로 보내야합니다.
GitHub 문제를 사용하여 버그 및 오류를 추적합니다. 프로젝트와 관련된 문제가 발생하면 다음과 같습니다.
- 문제를여십시오. (이 시점에서 버그인지 여부는 확신 할 수 없으므로 아직 버그에 대해 이야기하지 말고 문제에 레이블을 지정하지 말라고 요청합니다.)
- 당신이 기대할 행동과 실제 행동을 설명하십시오.
- 가능한 한 많은 맥락을 제공하고 다른 사람이 자신의 문제를 스스로 재현하기 위해 따라갈 수있는 재생산 단계를 설명하십시오. 여기에는 일반적으로 코드가 포함됩니다. 좋은 버그 보고서를 위해서는 문제를 분리하고 테스트 케이스를 줄여야합니다.
- 이전 섹션에서 수집 한 정보를 제공하십시오.
일단 제출되면 :
- 프로젝트 팀은 그에 따라 문제에 레이블을 지정합니다.
- 팀원은 제공된 단계로 문제를 재현하려고합니다. 재생산 단계가 없거나 문제를 재현 할 수있는 명백한 방법이없는 경우, 팀은 해당 단계를 요청하고 문제를
needs-repro 로합니다. needs-repro 태그가있는 버그는 재현 될 때까지 해결되지 않습니다. - 팀 이이 문제를 재현 할 수 있다면, 다른 태그 (예 :
critical )뿐만 아니라 needs-fix 표시되며 문제는 누군가가 구현해야합니다.
개선 제안
이 섹션 에서는 완전히 새로운 기능과 기존 기능에 대한 약간의 개선을 포함하여 Contributing.md에 대한 개선 제안을 제출함으로써 안내합니다. 이 가이드 라인에 따라 관리자와 커뮤니티가 귀하의 제안을 이해하고 관련 제안을 찾는 데 도움이됩니다.
강화를 제출하기 전에
- 최신 버전을 사용하고 있는지 확인하십시오.
- 문서를주의 깊게 읽고 개별 구성에 의해 기능이 이미 다루어 있는지 확인하십시오.
- 향상이 이미 제안되었는지 확인하기 위해 검색을 수행하십시오. 그렇다면 새 문제를 여는 대신 기존 문제에 주석을 추가하십시오.
- 당신의 아이디어가 프로젝트의 범위와 목표에 맞는지 알아보십시오. 프로젝트의 개발자 에게이 기능의 장점을 설득하는 것은 강력한 사례를 만드는 것은 당신에게 달려 있습니다. 작은 서브 세트뿐만 아니라 대부분의 사용자에게 유용한 기능을 원한다는 점을 명심하십시오. 소수의 사용자를 대상으로하는 경우 애드온/플러그인 라이브러리를 작성하는 것이 좋습니다.
좋은 향상 제안을 어떻게 제출합니까?
향상 제안은 GitHub 문제로 추적됩니다.
- 이 문제에 대해 명확하고 설명적인 제목을 사용하여 제안을 식별하십시오.
- 가능한 많은 세부 사항에서 제안 된 향상에 대한 단계별 설명을 제공하십시오.
- 현재 행동을 설명 하고 대신에 볼 것으로 예상되는 행동과 이유를 설명하십시오 . 이 시점에서 어떤 대안이 당신에게 효과가 없는지 알 수 있습니다.
- 스크린 샷과 애니메이션 GIF를 포함하여 단계를 보여 주거나 제안과 관련된 부분을 지적하는 데 도움이 될 수 있습니다. 이 도구를 사용하여 MacOS 및 Windows에서 GIF를 녹음 할 수 있으며이 도구 또는이 도구는 Linux 에서이 도구를 사용할 수 있습니다.
- 이 향상이 왜 가장 기여하는 사용자에게 유용한지를 설명하십시오 . 당신은 또한 그것을 더 잘 해결하고 영감을 줄 수있는 다른 프로젝트를 지적하고 싶을 수도 있습니다.
