Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Wisk Evolution

Pull Request Guidelines

When creating a pull request (PR), please follow these guidelines to ensure a smooth and efficient review process.

Title and Description

  • Use a clear and descriptive title that summarizes the purpose of the PR.
  • Provide a detailed description of the changes, including why they are necessary and how they benefit the project.
  • Reference any relevant issue or feature request numbers in the description (e.g., “Fixes #123”).

Code Quality

  • Ensure that your code follows the project’s coding standards and style guide.
  • Avoid unnecessary changes or unrelated code modifications.
  • Remove debugging or commented-out code.

Testing

  • Write tests for new features or bug fixes.
  • Ensure that existing tests pass successfully.
  • Provide clear instructions for reviewers on how to test the changes.

Documentation

  • Document code changes, including any new APIs or updates to existing documentation.
  • Keep README, comments, and inline documentation up to date.

Dependencies

  • Avoid introducing new, unnecessary dependencies.
  • Update existing dependencies to the required versions.

Security

  • Handle sensitive data securely.
  • Implement input validation and sanitization as needed.

Performance

  • Optimize heavy computations or database queries if applicable.
  • Ensure that your changes do not introduce performance regressions.

Compatibility

  • Verify that the code works across different browsers, devices, and platforms.

Reviewers

  • Assign the PR to the appropriate reviewers.
  • Notify reviewers if specific areas require their attention.

Merging

  • Ensure the PR is mergeable and free of conflicts with the target branch.
  • Keep the PR up to date with the latest changes from the target branch.

Communication

  • Discuss major architectural changes with the team.
  • Respond to comments and feedback in a timely and constructive manner.

CI/CD Integration

  • Configure the PR to trigger continuous integration (CI) builds and tests.
  • Verify that CI/CD pipelines are correctly set up.

Accessibility

  • Ensure that changes are accessible to users with disabilities.

Licensing

  • Confirm that the code complies with the project’s licensing terms.

User Interface (UI)

  • If applicable, check the user interface for consistent styling and user experience.

Clean Commit History

  • Maintain a clean and logical commit history. Use interactive rebase or squash commits as needed.

Final Review

  • Review the entire PR one last time before requesting a merge.