Skip to content

Commit 1b560a5

Browse files
ossf best practices improvements (#208)
* Add best practices badge * Add CoC * Add clang-format pre-commit check * Bump github/codeql-action from 4.31.0 to 4.31.3 Bumps [github/codeql-action](https://github.com/github/codeql-action) from 4.31.0 to 4.31.3. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@4e94bd1...014f16e) --- updated-dependencies: - dependency-name: github/codeql-action dependency-version: 4.31.3 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * Update copyright * Add concurrency to clang-format * Debug * Fix types * Remove debug changes * Exclude docs --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
1 parent a934b15 commit 1b560a5

File tree

8 files changed

+212
-7
lines changed

8 files changed

+212
-7
lines changed

.github/workflows/clang-format.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: clang-format
2+
on:
3+
workflow_dispatch:
4+
pull_request:
5+
push:
6+
branches:
7+
- develop
8+
9+
concurrency:
10+
group: clang-format-${{ github.event_name }}-${{ github.ref_name }}
11+
cancel-in-progress: true
12+
13+
permissions: read-all
14+
15+
jobs:
16+
clang-format:
17+
runs-on: ubuntu-latest-8-cores
18+
steps:
19+
- name: Checkout NPU Compiler
20+
uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
21+
with:
22+
fetch-depth: 0
23+
24+
- name: Setup python version
25+
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
26+
with:
27+
python-version: '3.13'
28+
29+
- name: Run clang-format via pre-commit
30+
uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
31+
with:
32+
extra_args: clang-format

.github/workflows/codeql.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ jobs:
3333
uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
3434

3535
- name: Initialize CodeQL
36-
uses: github/codeql-action/init@014f16e7ab1402f30e7c3329d33797e7948572db # v4.31.3
36+
uses: github/codeql-action/init@e12f0178983d466f2f6028f5cc7a6d786fd97f4b # v4.31.4
3737
with:
3838
languages: ${{ matrix.language }}
3939
build-mode: ${{ matrix.build-mode }}
4040

4141
- name: Perform CodeQL Analysis
42-
uses: github/codeql-action/analyze@014f16e7ab1402f30e7c3329d33797e7948572db # v4.31.3
42+
uses: github/codeql-action/analyze@e12f0178983d466f2f6028f5cc7a6d786fd97f4b # v4.31.4
4343
with:
4444
category: "/language:${{matrix.language}}"
4545

.github/workflows/job_build_mlir_linux.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ jobs:
152152
153153
- name: Initialize CodeQL
154154
if: ${{ !steps.cache-restore.outputs.cache-hit && inputs.with-codeql }}
155-
uses: github/codeql-action/init@014f16e7ab1402f30e7c3329d33797e7948572db # v4.31.3
155+
uses: github/codeql-action/init@e12f0178983d466f2f6028f5cc7a6d786fd97f4b # v4.31.4
156156
with:
157157
languages: c-cpp
158158
build-mode: manual
@@ -239,7 +239,7 @@ jobs:
239239
- name: Perform CodeQL Analysis
240240
id: codeql-analyze
241241
if: ${{ !steps.cache-restore.outputs.cache-hit && inputs.with-codeql }}
242-
uses: github/codeql-action/analyze@014f16e7ab1402f30e7c3329d33797e7948572db # v4.31.3
242+
uses: github/codeql-action/analyze@e12f0178983d466f2f6028f5cc7a6d786fd97f4b # v4.31.4
243243
with:
244244
category: "/language:c-cpp"
245245
output: ${{ env.CODEQL_OUTPUTS }}
@@ -262,7 +262,7 @@ jobs:
262262
263263
- name: Upload CodeQL SARIF
264264
if: ${{ !steps.cache-restore.outputs.cache-hit && inputs.with-codeql }}
265-
uses: github/codeql-action/upload-sarif@014f16e7ab1402f30e7c3329d33797e7948572db # v4.31.3
265+
uses: github/codeql-action/upload-sarif@e12f0178983d466f2f6028f5cc7a6d786fd97f4b # v4.31.4
266266
with:
267267
sarif_file: ${{ env.CODEQL_OUTPUTS }}/filtered-results.sarif
268268
checkout_path: ${{ env.NPU_COMPILER_REPO }}

.github/workflows/scorecard.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ jobs:
4040
retention-days: 5
4141

4242
- name: "Upload to code-scanning"
43-
uses: github/codeql-action/upload-sarif@014f16e7ab1402f30e7c3329d33797e7948572db # v4.31.3
43+
uses: github/codeql-action/upload-sarif@e12f0178983d466f2f6028f5cc7a6d786fd97f4b # v4.31.4
4444
with:
4545
sarif_file: results.sarif

.pre-commit-config.yaml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
#
2+
# Copyright (C) 2022-2025 Intel Corporation
3+
# SPDX-License-Identifier: Apache-2.0
4+
#
5+
6+
default_install_hook_types: [pre-commit, commit-msg]
7+
repos:
8+
- repo: local
9+
hooks:
10+
- id: clang-format
11+
name: clang-format
12+
entry: clang-format -i
13+
language: python
14+
stages: [pre-commit]
15+
args: ["-style=file"]
16+
types: [c++]
17+
exclude: 'docs/.*|thirdparty/.*|sw_runtime_kernels/.*'
18+
require_serial: false
19+
additional_dependencies: ['clang-format==18.1.8']
20+
21+
- repo: https://github.com/pre-commit/pre-commit-hooks
22+
rev: v5.0.0
23+
hooks:
24+
- id: check-json
25+
exclude: .*tests/lit/.*
26+
- id: trailing-whitespace
27+
exclude: 'docs/.*|thirdparty/.*|sw_runtime_kernels/.*|.*.md'
28+
- id: end-of-file-fixer
29+
exclude: 'docs/.*|thirdparty/.*|sw_runtime_kernels/.*|.*.bin$|.*.cpp|.*.hpp|.*.db|.*.svg|.*.js'
30+
31+
- repo: https://github.com/hhatto/autopep8
32+
rev: v2.3.1
33+
hooks:
34+
- id: autopep8
35+
args:
36+
- --max-line-length
37+
- "119"
38+
- --in-place
39+
- --ignore
40+
- E402
41+
exclude: 'docs/.*|thirdparty/.*|sw_runtime_kernels/.*|.*.bin$'

CODE_OF_CONDUCT.md

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
CommunityCodeOfConduct AT intel DOT com.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright 2024 Intel Corporation
189+
Copyright 2024-2025 Intel Corporation
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
[![NPU Linux Driver](https://img.shields.io/badge/NPU-Linux_Drivers-lightblue)](https://github.com/intel/linux-npu-driver/releases)
1818

1919
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/openvinotoolkit/npu_compiler/badge)](https://scorecard.dev/viewer/?uri=github.com/openvinotoolkit/npu_compiler)
20+
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10402/badge)](https://www.bestpractices.dev/projects/10402)
2021

2122
</div>
2223

0 commit comments

Comments
 (0)