python / python/devguide

Add information how to deal with incorporation external code (license, credits)

Aberta
#928 2 comentários 3 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

topic-dev process type-feature
Linguagem predominante
Python
Estrelas
2.1k
Forks
1k
Merge médio
2d 12h
PRs com merge (30d)
12

Descrição

Describe the enhancement or feature you'd like
The devguide does not contain information what a triager and core dev has to do when adding files or non-trivial portions of code from an external project with non-core dev contributors. There are a couple of things we need to check or do:

  • Is the license compatible with PSFL?
  • Include proper provenance and license information in file header or comment before the code
  • Add license and origin to Docs/license.rst
  • Give credits to original authors
  • Properly document the provenance and license in commit message

Describe alternatives you've considered
We should ask VanL for guidance, too.

Additional context
See https://github.com/python/cpython/issues/95649 for a case that is missing proper license and provenance information.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece revisando a estrutura da documentação do devguide e a issue 95649 relacionada do CPython; em seguida, pergunte a VanL quais são as orientações pretendidas. Documente os requisitos de compatibilidade de licenças, proveniência, créditos, Docs/license.rst e mensagens de commit para que o procedimento seja completo e aplicável.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.