Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.11 KB

File metadata and controls

42 lines (31 loc) · 2.11 KB

Pull Request Template for Vehigo

Please fill out the following sections to help us review your pull request efficiently.

1. Title

A concise and descriptive title for your pull request. Please follow Conventional Commits guidelines if applicable.

Example: feat: Add user authentication module or fix: Resolve login button responsiveness

2. Description

Provide a detailed description of the changes introduced by this pull request. Explain what was changed and why. Include any relevant context or design decisions.

3. Related Issues

Link any relevant issues from the Vehigo repository that this pull request addresses or is related to. Use keywords like Closes #ISSUE_NUMBER, Fixes #ISSUE_NUMBER, or Resolves #ISSUE_NUMBER to automatically close issues when the PR is merged.

4. Changes Made

List the specific changes implemented in this pull request. Be as specific as possible, referencing file paths or component names where appropriate.

  • Change 1: Briefly describe the change.
  • Change 2: Briefly describe the change.
  • ...

5. Checklist

Before submitting, please ensure you have completed the following:

  • I have read the project's contributing guidelines.
  • My code follows the project's coding style and conventions.
  • I have performed a thorough self-review of my own code.
  • I have added comments to my code, especially in complex or non-obvious sections.
  • I have made corresponding updates to the documentation (e.g., README, API docs) if my changes require it.
  • My changes introduce no new warnings or errors during compilation/runtime.
  • I have added new tests or updated existing ones to cover my changes, and they pass locally.
  • Any dependent changes (e.g., API updates, library versions) have been addressed.

6. Screenshots/GIFs

If your changes affect the UI or introduce visual features, include screenshots or GIFs to demonstrate the updates. Use a tool like Loom for recordings if needed.

Example:

Before After
Before After