gitignore icon indicating copy to clipboard operation
gitignore copied to clipboard

Add HIP.gitignore

Open Young-TW opened this issue 7 months ago • 3 comments

Reasons for making this change

  • Provide an official, up-to-date .gitignore for AMD HIP (ROCm) that covers both the upstream ROCm/hip repo’s own ignores and the most common host‐build workflows (CMake, Ninja, Meson)
  • Avoid overbroad rules (e.g. .*) that would inadvertently ignore user dotfiles like .clang-format, .github/, .env, etc.
  • Include IDE/editor directories (.vscode/, .idea/) and common intermediate artifacts without cluttering the template
  • Ensure that tutorial/sample source files remain tracked, while only their generated binaries and logs are ignored

Links to documentation supporting these rule changes

  • Official ROCm HIP .gitignore in upstream repo:
    https://github.com/ROCm/hip/blob/amd-staging/.gitignore
  • ROCm HIP project documentation:
    https://rocm.docs.amd.com/projects/HIP/en/latest/index.html
  • GitHub’s guide on creating .gitignore templates:
    https://github.com/github/gitignore#what-makes-a-good-template

If this is a new template

Link to application or project’s homepage:
https://github.com/ROCm/hip

Merge and Approval Steps

  • [x] Confirm that you've read the contribution guidelines and ensured your PR aligns
  • [ ] Ensure CI is passing
  • [ ] Get a review and approval from one of the maintainers

Young-TW avatar Jun 11 '25 07:06 Young-TW

@Young-TW could you please strip this down to be very HIP focused? We try not to throw everything into our templates and instead make them very specific to the language or technology in question.

wirecat avatar Jun 13 '25 22:06 wirecat

Thanks for the review. I’ve removed all OS- and editor-specific rules, leaving only HIP/ROCm build artifacts and sample outputs. Please let me know if any further tweaks are needed!

Young-TW avatar Jun 14 '25 02:06 Young-TW

I’ve rebased onto upstream/main to remove the merge commit and then force-pushed (--force-with-lease). The branch history is now linear — please let me know if you’d like any further adjustments.

Young-TW avatar Jun 14 '25 03:06 Young-TW