Skip to content

Pull Requests

This page provides guidelines for creating and reviewing pull requests for the HCB codebase.

Creating Pull Requests

When creating a pull request, please:

  1. Provide a descriptive title that summarizes the changes
  2. Fill out the PR template with relevant information
  3. Link to any related issues using GitHub's issue linking syntax
  4. Include screenshots or videos if your changes affect the UI
  5. Add tests for new functionality or bug fixes
  6. Make sure CI passes before requesting review

Reviewing Pull Requests

When reviewing a pull request, please:

  1. Be constructive and respectful in your feedback
  2. Consider the context of the changes
  3. Look for potential issues with security, performance, or user experience
  4. Test the changes locally if possible
  5. Suggest alternatives if you think there's a better approach

Merging Pull Requests

Pull requests should be merged by the author after receiving approval from at least one reviewer and passing all CI checks.

PR Templates

More detailed templates and guidelines will be added here in the future.