Skip to content

Submitting a Pull Request

Vivek Kale edited this page Mar 29, 2023 · 1 revision

Each Github Issue should eventually have a PR associated with it. When submitting a PR, explain the problem you are solving and your approach to it, with the text 'Fixes PR #42' if the Kokkos Tools PR is #42.

Continuous Integration / Development

The Kokkos Tools repository uses CI/CD processes to ensure software stability, robustness and integration within the Kokkos ecosystem.

Build Systems

The Kokkos Tools set uses cmake or Makefiles to configure and build Kokkos Tools. The Kokkos Tools is looking into spack packaging but it is not supported at this time. Please include a Makefile in your Kokkos Tools connector that you develop.

Code Formatting

The Kokkos Tools development uses clang-format-8 for code formatting as part of its CI. In your connector, you should have a file .clang-format. You should also run clang-format-8 on your local machine before submitting a PR in order for the CI checks to pass.

Collaborating through Git

The Kokkos Tools developers and Kokkos developers use standard git and GitHub features, and encourage one to review knowledge of git and GitHub if one hasn't done so. In particular, we suggest reviewing the following:

  • branching
  • committing
  • merging cherry-picking contributing to an existing PR rewriting history through git rebase or git reset reading status through: git status, git log, and git diff Important: A PR to the Kokkos tools repo is always against the develop branch.

Each PR needs at least one reviewer (and in some cases two) from the Kokkos Tools developers team for it to be merged. (This process of reviewing and finally approving can take on the order of weeks, but the developers will your PR assigned to reviewers within a 2-3 days and start reviewing it by then).

Clone this wiki locally