Skip to content

Latest commit

 

History

History
115 lines (94 loc) · 5.33 KB

CONTRIBUTING.md

File metadata and controls

115 lines (94 loc) · 5.33 KB
Raw

Contributing

License

Intel Project for LLVM* technology is licensed under the terms of the Apache License v2.0 with LLVM Exceptions license (LICENSE.txt) to ensure our ability to contribute this project to the LLVM project under the same license.

By contributing to this project, you agree to the Apache License v2.0 with LLVM Exceptions and copyright terms there in and release your contribution under these terms.

Contribution process

Development

For any changes not related to Intel Project for LLVM* technology, but rather to LLVM in general, it is strongly encouraged that you submit the patch to https://llvm.org/ directly. See LLVM contribution guidelines for more information.

Every change should be accompanied with corresponding test modification (adding new test(s), extending, removing or modifying existing test(s)).

To contribute:

  • Create a personal fork of the project on GitHub
  • Prepare your patch

    • Follow LLVM coding standards

    • Clang-format and clang-tidy tools can be integrated into your workflow to ensure formatting and stylistic compliance of your changes. To avoid code formatting misalignment with GitHub Actions check we recommend using 10 version of clang-format tool (default version on Ubuntu 22.04).

    • Use

      ./clang/tools/clang-format/git-clang-format `git merge-base origin/sycl HEAD`

      to check the format of your current changes. origin/sycl branch is an example here

      • -f to also correct unstaged changes
      • --diff to only print the diff without applying

Project-specific contribution guidelines

Pull request

  • When creating your commit messages, please make sure to follow LLVM developer policies on the subject.
  • To a reasonable extent, title tags can be used to signify the component changed, e.g.: [PI], [CUDA], [Doc].
  • Create a pull request (PR) for your changes following Creating a pull request instructions.
    • Make sure PR has a good description explaining all of the changes made, represented by commits in the PR.
    • When PR is merged all commits are squashed and PR description is used as the merged commit message.
    • Consider splitting the large set of changes on small independent PRs that can be reviewed, tested and merged independently.
  • For changes which require modification in tests outside of the current repository the commit message should contain the link to corresponding test PR. For example: KhronosGroup/SYCL-CTS#65. (see Autolinked references and URLs for more details). The same message should be present both in commit message and in PR description.

Review and acceptance testing

  • CI will run several build and functional testing checks as soon as the PR is approved by an Intel representative.
    • By default, pre-commit activies (build/test) will not auto start when PR is submitted for new contributors and non members of the project. If your PR shows "workflow awaiting approval" then your assigned code reviewer or another member of the project will need to approve the test run and start it for you. If you are unable to reach someone to approve your run, please contact the project gatekeepers (@intel/llvm-gatekeepers).
    • A new approval is needed if the PR was updated (e.g. during code review).
  • Once the PR is approved and all checks have passed, the pull request is ready for merge.
  • Sometimes unrelated fails can be observed in the PR. It's author responsibility to find/guess the reason of these fails and post a comment in the PR with:
    • Possible reason of fails, ideally with a link to the PR, which caused fails
    • Link to other PR(s), which expected to fix fails
    • Person who is currently looking into fails
    • Link to existing open issue
    • If author cannot identify any of these, the minimal action expected is to open a new issue
    • List of unrelated tests failing in pre-commit CI. This would enable easy access to them via github search functionality.

Merge

Project gatekeepers (@intel/llvm-gatekeepers) merge pull requests using [Squash and merge] and using PR description as the commit message, replacing all individual comments made per commit. Authors of the change must ensure PR description is up to date at the merge stage, as sometimes comments addressed during code reviews can invalidate original PR description. Feel free to ping @intel/llvm-gatekeepers if your PR is green and can be merged. Note that gatekeepers will require explanation for any failures observed.

Pulldown from LLVM upstream is done through merge commits to preserve hashes of the original commits pulled from the LLVM community repository.

*Other names and brands may be claimed as the property of others.