Skip to content

Latest commit

 

History

History
122 lines (87 loc) · 6.29 KB

contributing.md

File metadata and controls

122 lines (87 loc) · 6.29 KB

Contributing

비트코인 해례본의 기여자 여러분을 환영합니다. 양질의 지식을 쌓아가기 위해 레파지토리에 기여할 때
먼저 이 레파지토리의 Issues 탭의 이슈 제안을 통해 추가, 변경하고자 하는 내용을 등록해 주세요.
새로운 제안이나 콘텐츠, 수정이 필요한 사항 모두 환영해요.

지원이 필요하신 경우, 이메일 혹은 트위터를 통해 언제든 질문해 주세요.

🧡 참여 프로세스

  1. 레파지토리를 Fork - Clone 해주세요.

  2. prefix-naming 형식의 브랜치를 생성하고 로컬에서 작업해주세요.

    카테고리 prefix 예
    마스터링 비트코인 mb mb-ch07
    배경지식 bg bg-coldwallet
    BIP bip bip-0174
    마스터링 LN ln ln-ch07
    비트코인 한걸음 onestep onestep-ch01 
    문서의 일관성을 유지하기 위해 꼭 지켜주세요. 🤙

1. 비트코인 해례 프로젝트는 Markdown으로 작성하고 있어요.
2. 작성하시는 카테고리에 맞는 폴더에 파일을 생성해 주세요.
3. 문서의 제목은 Heading level 1으로 작성해 주세요.
4. 문서 제목 바로 밑에 블록 인용구(Blockquotes) 형식으로 원본 출처를 기입해 주세요.
5. 인용구 바로 아래는 목차 자리예요. 되도록이면 목차를 작성해 주세요.
6. 용어 설명, 필요한 개념, 해석을 덧붙이는 등 추가 설명이 필요한 경우 블록 인용구를 사용해 주세요.
7. 별도의 이미지가 있는 경우 카테고리 폴더 하위에 폴더를 생성하고 이미지 파일을 위치 시켜 주세요.
8. 카테고리 폴더 > index.md도 함께 업데이트해 주세요.

    • 마크다운 문법 (링크)

    • 문서 제목 예시

      BIP-39

    • 원본 출처 기입 예시

      📖 원문: BIP-0039

    • 추가 설명 기입 예시

      💡 시드(Seed)

      난수 생성기(Random Number Generator, 무작위 수를 출력)에 사용되는 입력값을 말한다.

    • 별도 작업한 이미지가 있는 경우 이미지를 위한 카테고리 하위 폴더 생성

        ./
  ├── background
  │   ├── 01_ECDSA
  │   ├── 01_ECDSA.md
  │   └── index.md
  ...

    • 각 카테고리별로 다음 문서 포맷을 참고해주세요.

      카테고리 문서 포맷
      마스터링 비트코인 mastering-bitcoin.md
      마스터링 LN lnbook.md
      bip bip.md
      기타 etc.md

  3. 로컬 레파지토리에 반영 후 원본 레파지토리에 Pull Request를 보내주세요.

  4. 프로젝트 관리자가 검토합니다.

행동 강령 Code of Conduct

우리의 다짐 Our Pledge

개방적이고 환영하는 환경을 조성하기 위해 우리는 기여자와 관리자는 프로젝트에 참여할 것을 서약합니다. 나이, 신체, 장애, 인종, 성 정체성, 표현, 경험 수준에 관계없이 모든 사람이 괴롭힘 없는 경험을 할 수 있는 커뮤니티를 만들 것을 약속합니다.

표준 Our Standards

긍정적인 환경을 조성하는 데 기여하는 행동의 예는 다음과 같습니다.

  • 따뜻하고 포용적인 언어 사용하기
  • 서로 다른 관점과 경험을 존중하기
  • 건설적인 비판을 정중하게 수용하기
  • 커뮤니티를 위해 무엇이 최선인지에 집중하기
  • 다른 커뮤니티 구성원에게 공감 표시하기

허용될 수 없는 행동의 예는 다음과 같습니다.

  • 성적인 언어나 이미지 사용 및 원치 않는 성적 관심 또는 접근
  • 트롤링, 모욕적/경멸적 댓글, 인신공격 또는 정치적 공격
  • 공개적 또는 사적인 괴롭힘
  • 명시적인 허가 없이 타인의 실제 또는 전자 주소와 같은 개인 정보 게시
  • 명시적인 허가 없이 타인의 주소 등 개인 정보 게시
  • 전문적 환경에서 합리적으로 부적절하다고 간주될 수 있는 기타 행위

범위 Scope

본 행동 강령은 개인이 프로젝트나 커뮤니티를 대표하여 행동하는 프로젝트 공간과 공공 공간 모두에서 적용됩니다. 프로젝트 또는 커뮤니티를 대표하는 행위에는 공식 프로젝트 이메일 사용 주소 사용, 공식 소셜 미디어 계정을 통한 게시, 온라인 또는 오프라인 이벤트에서 대표로 활동하는 경우 등이 해당됩니다. 프로젝트의 대표성은 프로젝트 관리자가 추가로 정의하고 명확히 할 수 있습니다.

시행 Enforcement

학대, 괴롭힘 또는 기타 용납할 수 없는 행동의 경우 이메일로 프로젝트 팀에 연락하여 신고할 수 있습니다. 모든 불만 사항은 검토 및 조사를 거쳐 상황에 따라 필요하고 적절한 것으로 간주되는 경우 응답을 받게 됩니다. 프로젝트 팀은 사건 신고자와 관련하여 기밀을 유지할 의무가 있으며 구체적인 시행 정책에 대한 자세한 내용은 별도로 게시될 수 있습니다.

행동강령을 성실하게 따르지 않거나 시행하지 않는 프로젝트 관리자는 리더십의 다른 구성원이 결정한 대로 일시적 또는 영구적인 영향을 받을 수 있습니다.

Attribution

본 행동 강령은 Contributor Covenant의 1.4 버전을 수정 및 한글화하였습니다. 여기에서 1.4 버전 원문을 확인하실 수 있습니다.