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

Feature/pull request template #5

Merged
merged 1 commit into from
Jan 17, 2024

Conversation

JakobEliasWagner
Copy link
Owner

@JakobEliasWagner JakobEliasWagner commented Jan 17, 2024

Description

Adds a new and more comprehensive template for pull requests.
This is motivated by ensuring better and easier to review pull request, which improves the quality of the code.

Type

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

Checklist

  • Code
    • Title and Description are concise and descriptive.
    • PR is linked to all related issues.
    • PR is raised from a correctly named branch.
    • Target branch is correct.
    • Commits are squashed if necessary
    • Commits conform to the guidelines
  • Code Quality
    • Well written and understandable
    • Code passes all linting checks
    • Formatting
    • Code is not overly complex
  • Quality Assessment
    • Adequate Unit tests are written
    • Unit tests are passing
    • Features work as expected/bug fixes resolve issue
    • Other means of quality insurance added (if necessary)
  • Documentation
    • All new features include documentation
    • README is updated
  • Review
    • Has been reviewed by author
    • Has been reviewed by at least one other team member
    • Merge conflicts with target branch are resolved
  • CI/CD passes all pipeline checks
  • Post Merge
    • Delete the feature branch (if applicable).
    • Update related issues or project boards.

@JakobEliasWagner JakobEliasWagner force-pushed the feature/pull-request-template branch from c5fed2a to 159dc9d Compare January 17, 2024 13:30
@JakobEliasWagner
Copy link
Owner Author

Merged to use this feature for upcomming pull requests

@JakobEliasWagner JakobEliasWagner merged commit a08a85f into main Jan 17, 2024
3 checks passed
@JakobEliasWagner JakobEliasWagner deleted the feature/pull-request-template branch January 18, 2024 17:29
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.

1 participant