Pythonia

Pythonia

Bem -vindo ao Pythonia - o repositório de coleção de funções Python! Este é um repositório público em que qualquer pessoa pode contribuir com suas funções python. Seja um script único ou um projeto mais complexo dividido em vários arquivos, suas contribuições são bem -vindas.

Índice

• Sobre
• Como contribuir
• Diretrizes
• Estrutura de pastas
• Licença
• Contribuir

Sobre

Este repositório é uma coleção de várias funções e scripts Python. O objetivo é criar um conjunto diversificado de funções úteis que possam ajudar outros desenvolvedores e entusiastas. As contribuições podem variar de funções de utilidade simples a projetos mais complexos.

Como contribuir

Contribuir para este repositório é simples. Siga as etapas abaixo para começar:

1. Gifra o repositório : clique no botão Fork no canto superior direito desta página.
2. Clone o garfo : clone o repositório bifurcado à sua máquina local.

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

3. ** Crie uma nova filial: crie uma nova ramificação para suas contribuições.

   git checkout -b my-new-function

4. Adicione sua função: adicione suas funções Python à pasta apropriada ou crie uma nova.
5. Comprometa suas alterações: Compreenda suas alterações com uma mensagem de confirmação significativa.

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

6. Empurre para o garfo: empurre suas alterações no repositório bifurcado.

   git push origin my-new-function

7. Crie uma solicitação de tração: vá para o repositório original e clique no botão New Pull Request .
8. Atualize também o arquivo "requisitos.txt" de acordo com o seu projeto.

Diretrizes

Para garantir que o repositório permaneça organizado e útil, siga estas diretrizes ao contribuir:

• Organize o código nas pastas: se sua contribuição consistir em vários arquivos ou peças, coloque -os dentro de uma pasta. Nomeie a pasta descritivamente.
• Contribuições de arquivo único: Se sua contribuição for um único arquivo python, coloque -o diretamente na seção apropriada.
• Convenções de nomeação: use nomes descritivos para arquivos e pastas. Evite nomes genéricos como script.py ou function.py.
• Documentação: Inclua comentários e documentos em seu código para explicar sua funcionalidade.
• Teste: se possível, inclua um pequeno script de teste ou exemplo mostrando como usar sua função.
• Informações da licença: verifique se suas contribuições são compatíveis com a licença do repositório (veja abaixo).

Estrutura de pastas

Organize o repositório de maneira significativa. Aqui está uma estrutura de exemplo:

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

• single_file_functions: para contribuições de arquivo python único.
• Multi_Part_functions: Para projetos com várias partes/arquivos. Cada projeto deve ter sua própria pasta.
• Readme.md: este arquivo.

Licença

Este projeto está licenciado sob a licença do MIT. Ao contribuir, você concorda que suas contribuições serão licenciadas sob a licença do MIT.

Contribuir

Congratulamo -nos com contribuições de todos. Veja como você pode ajudar:

• Envie relatórios de bug e solicitações de recursos: use o rastreador de problemas para relatar bugs ou sugerir recursos.
• Revise as solicitações de tração: Revise as solicitações de puxar de outros colaboradores.
• Melhore a documentação: ajude a melhorar este ReadMe, adicionar comentários e melhorar a documentação do código.