Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEV: Improve contributing docs #2374

Closed
stefan6419846 opened this issue Dec 27, 2023 · 3 comments · Fixed by #2378
Closed

DEV: Improve contributing docs #2374

stefan6419846 opened this issue Dec 27, 2023 · 3 comments · Fixed by #2378
Labels
nf-documentation Non-functional change: Documentation

Comments

@stefan6419846
Copy link
Collaborator

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.

@MartinThoma MartinThoma added the nf-documentation Non-functional change: Documentation label Dec 28, 2023
@MartinThoma
Copy link
Member

I'm open to suggestions how to change the CONTRIBUTING.md.

PRs from new contributors tend to not use our desired naming scheme/prefixes. Ideally, we would add a corresponding check to the PR CI

Sounds like it might be something easy to implement (in CI) with a very clear error message, thus easy to fix for the contributor. It sounds also like something that would make my life easier 👍

We should make clear that we can support there. Something like: "If you don't know which one to choose or if multiple apply, make a best guess. Nobody will complain if it doesn't quite fit :-)"

@MartinThoma
Copy link
Member

https://stackoverflow.com/a/71692835/562769 :

on:
  push:
  pull_request:
   types: [opened, synchronize]

  print_title_of_pr:
    runs-on: ubuntu-20.04
    steps:
    - name : Print Title of PR
      run: echo The Title of your PR is ${{ github.event.pull_request.title }}

@stefan6419846
Copy link
Collaborator Author

I am going to see if I am able to create corresponding PRs tomorrow to improve this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nf-documentation Non-functional change: Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants