Skip to content

Add a PR template#443

Open
mozzieongit wants to merge 1 commit intomainfrom
gh-pr-template
Open

Add a PR template#443
mozzieongit wants to merge 1 commit intomainfrom
gh-pr-template

Conversation

@mozzieongit
Copy link
Member

We had previously talked about forgetting to update the man page configuration when adding or removing pages; and now worry about forgetting to run the integration tests. This PR template would serve as a reminder for anyone opening PRs.


  • If you are changing Rust code or integration tests (Cargo.*, crates/, etc/, integration-tests/, src/):

    • Did you run the integration tests with act through the act-wrapper (as described in TESTING.md)?
  • If you are adding/deleting man pages:

    • Did you update the man_pages config in doc/manual/source/conf.py?
    • Did you update the packaged man pages in the Cargo.toml?

@mozzieongit mozzieongit requested review from bal-e and ximon18 February 2, 2026 14:41
@mozzieongit mozzieongit self-assigned this Feb 2, 2026
@mozzieongit
Copy link
Member Author

I don't know if the

(Cargo.*, crates/, etc/, integration-tests/, src/)

is helpful or distracting.

@ximon18
Copy link
Member

ximon18 commented Feb 2, 2026

Nice. Man pages also need to be make man'd to generate the final man page, should that be part of this list too? Or should they be generated prior to release/packaging? Or even ideally by packaging?

@Philip-NLnetLabs
Copy link
Member

We have the generated man pages in git. So ideally they should be part of a PR when the documentation is changed.

@bal-e
Copy link
Contributor

bal-e commented Feb 4, 2026

Perhaps CI can check whether make man causes changes / seems out of date?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants