Skip to content

Conversation

@saisilinus
Copy link
Collaborator

Pull Request

Description

Adds a template for documenting pull requests. The purpose is to standardise the documentation of PRs and make sure that certain information is provided.

Type of change

Please delete options that are not relevant.

  • Documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.

I haven't run any tests since it does not affect the functionality of the app. Also, I will have to merge the PR before testing.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Add a template for documenting pull requests
@timmwille
Copy link
Member

ah good Idea, actually most types of PRs also include content updates specifically, I see if I find time to improve that to our use case

@timmwille timmwille mentioned this pull request Jan 28, 2026
@saisilinus
Copy link
Collaborator Author

Sure

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants