Pythonia

Питония

Добро пожаловать в Pythonia - хранилище сбора функций Python! Это публичный хранилище, где каждый может внести свой вклад в свои функции Python. Будь то один сценарий или более сложный проект, разделенный на несколько файлов, ваши взносы приветствуются.

Оглавление

• О
• Как внести свой вклад
• Руководящие принципы
• Структура папки
• Лицензия
• Способствовать

О

Этот репозиторий представляет собой набор различных функций и сценариев Python. Цель состоит в том, чтобы создать разнообразный набор полезных функций, которые могут помочь другим разработчикам и энтузиастам. Взносы могут варьироваться от простых коммунальных функций до более сложных проектов.

Как внести свой вклад

Внести свой вклад в этот репозиторий прост. Следуйте шагам ниже, чтобы начать:

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. Также обновите файл «tedds.txt» в соответствии с вашим проектом.

Руководящие принципы

Для обеспечения того, чтобы хранилище оставалось организованным и полезным, пожалуйста, следуйте этим рекомендациям при вклад:

• Организуйте код в папках: если ваш вклад состоит из нескольких файлов или деталей, поместите их в папку. Назовите папку описательно.
• Взносы с одним файлом: если ваш вклад - один файл Python, поместите его непосредственно в соответствующий раздел.
• Конвенции именования: используйте описательные имена для файлов и папок. Избегайте общих имен, таких как script.py или function.py.
• Документация: Включите комментарии и Docstrings в ваш код, чтобы объяснить его функциональность.
• Тестирование: если возможно, включите небольшой тестовый скрипт или пример, показывающий, как использовать вашу функцию.
• Информация о лицензии: убедитесь, что ваши взносы совместимы с лицензией репозитория (см. Ниже).

Структура папки

Организовать хранилище значимым образом. Вот пример структура:

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

• single_file_functions: для единого вклада файла Python.
• multi_part_functions: для проектов с несколькими частями/файлами. Каждый проект должен иметь свою собственную папку.
• Readme.md: этот файл.

Лицензия

Этот проект лицензирован по лицензии MIT. Внеся свой вклад, вы соглашаетесь с тем, что ваши взносы будут лицензированы по лицензии MIT.

Способствовать

Мы приветствуем вклад всех. Вот как вы можете помочь:

• Отправьте отчеты об ошибках и запросы функций: используйте трекер выпуска, чтобы сообщать об ошибках или предложить функции.
• Просмотр запросов на вытягивание: просмотр запросов на вытягивание других участников.
• Улучшение документации: Помогите улучшить эту Readme, добавить комментарии и улучшить кодовую документацию.