Skip to content

DEV: Improve contributing docs #2374

@stefan6419846

Description

@stefan6419846

At the moment, https://github.com/py-pdf/pypdf/blob/main/CONTRIBUTING.md tends to be quite sparse and does not link to the developer information inside the docs for example: https://pypdf.readthedocs.io/en/latest/dev/intro.html

We probably want improve this.

Background: PRs from new contributors tend to not use our desired naming scheme/prefixes. Ideally, we would add a corresponding check to the PR CI (either as part of the existing codestyle job or inside a separate one), but this requires that this is clear for contributors to avoid confusion. GitHub usually shows/links the CONTRIBUTING.md file when creating an issue or PR, especially for firs-timers.

Metadata

Metadata

Assignees

No one assigned

    Labels

    nf-documentationNon-functional change: Documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions