python / python/devguide

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

Open
#928 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

topic-dev process type-feature
Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the devguide documentation structure and the related CPython issue 95649, then ask VanL for the intended guidance. Document the license-compatibility, provenance, credits, Docs/license.rst, and commit-message requirements so the procedure is complete and actionable.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.