Pythonia

피해자

Pythonia - Python Functions Collection Repository에 오신 것을 환영합니다! 이것은 누구나 파이썬 기능을 제공 할 수있는 공개 저장소입니다. 단일 스크립트이든 더 복잡한 프로젝트이든 여러 파일로 나뉘 든 기여를 환영합니다.

목차

• 에 대한
• 기여하는 방법
• 지침
• 폴더 구조
• 특허
• 기여하다

에 대한

이 저장소는 다양한 파이썬 기능 및 스크립트 모음입니다. 목표는 다른 개발자와 애호가를 도울 수있는 다양한 유용한 기능 세트를 만드는 것입니다. 기부금은 간단한 유틸리티 기능에서보다 복잡한 프로젝트에 이르기까지 다양합니다.

기여하는 방법

이 저장소에 기여하는 것은 간단합니다. 아래 단계를 따라 시작하려면 :

1. 포크 리포지토리 :이 페이지의 오른쪽 상단에있는 Fork 버튼을 클릭하십시오.
2. 포크를 복제하십시오 : 포크 리 저장소를 로컬 컴퓨터로 복제하십시오.

   git clone https://github.com/ < your-username > /python-functions-collection.git

3. ** 새 지점 만들기 : 기부금을위한 새 지점을 만듭니다.

   git checkout -b my-new-function

4. 기능 추가 : Python 기능을 적절한 폴더에 추가하거나 새 폴더를 작성하십시오.
5. 변경 사항을 커밋하십시오 : 의미있는 커밋 메시지로 변경 사항을 커밋하십시오.

   git add .
   git commit -m " Add new function for XYZ "

6. 포크로 밀어 넣으십시오. 변경 사항을 포크 리포지토리로 밀어 넣으십시오.

   git push origin my-new-function

7. 풀 요청 생성 : 원래 저장소로 이동하여 New Pull Request 버튼을 클릭하십시오.
8. 또한 프로젝트에 따라 "요구 사항.txt"파일을 업데이트하십시오.

지침

저장소가 체계적이고 유용한 상태를 유지하려면 다음과 같은 가이드 라인을 따르십시오.

• 폴더에서 코드 구성 : 기여가 여러 파일 또는 부품으로 구성된 경우 폴더 안에 배치하십시오. 폴더의 이름을 묘사 적으로 지정하십시오.
• 단일 파일 기여 : 기부금이 단일 Python 파일 인 경우 해당 섹션에 직접 배치하십시오.
• 이름 지정 규칙 : 파일 및 폴더의 설명 이름을 사용합니다. script.py 또는 function.py와 같은 일반적인 이름을 피하십시오.
• 문서 : 코드에 댓글과 문서를 포함하여 기능을 설명하십시오.
• 테스트 : 가능하면 기능 사용 방법을 보여주는 작은 테스트 스크립트 또는 예제를 포함하십시오.
• 라이센스 정보 : 기부금이 저장소 라이센스와 호환되는지 확인하십시오 (아래 참조).

폴더 구조

의미있는 방식으로 저장소를 구성하십시오. 예제 구조는 다음과 같습니다.

  Pytonia/
  |
  | -- single_file_functions/
  |   | -- example_function.py
  |
  | -- multi_part_functions/
  |   | -- project_name/
  |       | -- part1.py
  |       | -- part2.py
  |       | -- README.md
  |
  | -- README.md

• Single_File_Functions : 단일 파이썬 파일 기여 용.
• Multi_Part_Funtions : 여러 부품/파일이있는 프로젝트 용. 각 프로젝트에는 자체 폴더가 있어야합니다.
• readme.md :이 파일.

특허

이 프로젝트는 MIT 라이센스에 따라 라이센스가 부여됩니다. 기여함으로써 귀하는 귀하의 기부금이 MIT 라이센스에 따라 라이센스가 부여된다는 데 동의합니다.

기여하다

우리는 모든 사람의 기여를 환영합니다. 도움을 줄 수있는 방법은 다음과 같습니다.

• 버그 보고서 및 기능 요청 제출 : 문제 추적기를 사용하여 버그를보고하거나 기능을 제안합니다.
• 풀 요청 검토 : 다른 기여자의 풀 요청을 검토하십시오.
• 문서 개선 :이 읽기를 개선하고 의견을 추가하며 코드 문서를 개선하는 데 도움이됩니다.