Add updated pull request template

[JakobEliasWagner]

Description

Summary of the changes and the related issue.
Relevant motivation and context.
Dependencies that are required for this change.

Type

• Feature
• Bug Fix
• Documentation Update
• Style
• Code Refactor
• Performance Improvements
• Builds
• CI

Checklist

General Checklist

• Title and Description:

  • PR title is concise and descriptive.
  • PR description provides context and summarizes the changes.

• Linked Issues:

  • PR is linked to all related GitHub issues.

• Branching:

  • PR is raised from a correctly named feature or bug-fix branch.
  • Target branch (like main or develop) is correct.

• Commits:

  • Commits are squashed if necessary and messages are clear and conform to the project's guidelines.

Code Quality and Standards

• Code Quality:

  • Code is well-written, understandable, and follows project's coding standards.

• Linting and Style:

  • Code passes all linting checks.
  • Code formatting adheres to project style guide.

• Complexity and Refactoring:

  • Code is not overly complex; refactor if necessary.
  • Duplicated code is minimized.

Testing and Documentation

• Unit Tests:

  • Adequate unit tests are written for new features and bug fixes.
  • Tests are passing.

• Documentation:

  • All new features or public methods/functions include documentation.
  • README and other documentation are updated if necessary.

Functionality and Performance

• Functionality:

  • New features work as expected.
  • Bug fixes correctly resolve the issues.

• Performance:

  • Performance impacts are considered and addressed if applicable.

Review and Communication

• Peer Review:

  • PR has been reviewed by at least one other team member.
  • All review comments are addressed.

• Conflict Resolution:

  • Merge conflicts with the target branch are resolved.

Continuous Integration and Deployment

• CI/CD:
  • The PR passes all CI/CD pipeline checks.

Final Checks

• Final Review:

  • Conduct a final review and walkthrough of the changes.
  • Ensure all CI/CD checks are passing.

• Merge Readiness:

  • The PR is up-to-date with the base branch.
  • Ensure that the PR adds value to the project and aligns with the roadmap and project goals.

After Merge

• Post-Merge:
  • Delete the feature branch (if applicable).
  • Update related issues or project boards.