-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Closed
Labels
nf-documentationNon-functional change: DocumentationNon-functional change: Documentation
Description
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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
nf-documentationNon-functional change: DocumentationNon-functional change: Documentation