Skip to content

Commit dfd9423

Browse files
authored
Add misc. files, some copyright headers, and tweak a couple of details (#32)
Changes: * Add miscellaneous files like `SUPPORT.md` and a security policy statement * Add a `.editorconfig` file that matches the indentation & line length used in this project * Add some copyright headers to files at the top level * Make trivial tweaks to `setup.py` and `ci.yml`
1 parent 1627af9 commit dfd9423

File tree

12 files changed

+274
-2
lines changed

12 files changed

+274
-2
lines changed

.clang-format

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
# Copyright 2023 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# https://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# IMPORTANT: if you change values here, update .editorconfig to match.
116
---
217
Language: Cpp
318
BasedOnStyle: Google

.editorconfig

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# https://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
root = true
16+
17+
# We mostly follow Google style guides (https://google.github.io/styleguide/)
18+
# with only a few deviations for line length and indentation in some files.
19+
20+
# IMPORTANT: some of the other config files (.clang-format, etc.) also have
21+
# the same settings and need to be updated if changes are made to this file.
22+
[*]
23+
charset = utf-8
24+
indent_style = space
25+
insert_final_newline = true
26+
spelling_language = en-US
27+
trim_trailing_whitespace = true
28+
max_line_length = 120
29+
30+
[{BUILD,WORKSPACE}]
31+
indent_size = 4
32+
33+
[{CMakeLists.txt}]
34+
indent_size = 4
35+
36+
[{*.cc,*.h}]
37+
indent_size = 4
38+
39+
[*.py]
40+
indent_size = 4
41+
42+
[*.toml]
43+
indent_size = 4
44+
45+
[{*.yaml,*.yml,*.cff}]
46+
indent_size = 2

.github/SECURITY.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Reporting security issues
2+
3+
This project's developers and community are committed to addressing security
4+
bugs promptly and effectively. We appreciate your efforts to disclose your
5+
findings responsibly, and will make every effort to acknowledge your
6+
contributions.
7+
8+
Please **do not** use GitHub issues to report security vulnerabilities; GitHub
9+
issues are public, and doing so could allow someone to exploit the information
10+
before the problem can be addressed. Instead, please use the *Report a
11+
vulnerability* button from the *Security* tab at the top of this GitHub
12+
repository page.
13+
14+
Please report security issues in third-party modules to the person or team
15+
maintaining the module rather than this project's stewards, unless you believe
16+
that some action needs to be taken specifically with this project in order to
17+
guard against the effects of a security vulnerability in third-party software.
18+
19+
## Responses to security reports
20+
21+
The project stewards at Google Quantum AI will send a response indicating the
22+
next steps in handling your report. After the initial reply to your report, the
23+
project stewards will keep you informed of the progress towards a fix and full
24+
announcement, and may ask for additional information or guidance.
25+
26+
## Additional points of contact
27+
28+
Please contact the project stewards at Google Quantum AI via email at
29+
quantum-oss-maintainers@google.com if you have questions or other concerns. If
30+
for any reason you are uncomfortable reaching out to the project stewards,
31+
please email opensource@google.com instead.

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,6 @@ jobs:
273273
# For efficiency, test just one wheel for each platform.
274274
pattern: '*cp311*'
275275
merge-multiple: true
276-
- run: pwd && ls -lR dist-chromobius
277276
- uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1
278277
with:
279278
repository-url: ${{env.testpypi_endpoint_url}}
@@ -314,6 +313,7 @@ jobs:
314313
path: dist-chromobius
315314
pattern: dist-chromobius-*
316315
merge-multiple: true
316+
- run: pwd && ls -lR dist-chromobius
317317
- uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1
318318
with:
319319
packages-dir: dist-chromobius/

BUILD

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Copyright 2023 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
115
package(default_visibility = ["//visibility:public"])
216

317
load("@rules_python//python:packaging.bzl", "py_wheel")

CODE_OF_CONDUCT.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of
9+
experience, education, socio-economic status, nationality, personal appearance,
10+
race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or reject
41+
comments, commits, code, wiki edits, issues, and other contributions that are
42+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43+
contributor for other behaviors that they deem inappropriate, threatening,
44+
offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
This Code of Conduct also applies outside the project spaces when the Project
56+
Stewards have a reasonable belief that an individual's behavior may have a
57+
negative impact on the project or its community.
58+
59+
## Conflict Resolution
60+
61+
We do not believe that all conflict is bad; healthy debate and disagreement
62+
often yield positive results. However, it is never okay to be disrespectful or
63+
to engage in behavior that violates the project’s Code of Conduct.
64+
65+
If you see someone violating the Code of Conduct, you are encouraged to address
66+
the behavior directly with those involved. Many issues can be resolved quickly
67+
and easily, and this gives people more control over the outcome of their
68+
dispute. If you are unable to resolve the matter for any reason, or if the
69+
behavior is threatening or harassing, report it. We are dedicated to providing
70+
an environment where participants feel welcome and safe.
71+
72+
Reports should be directed to quantumai-oss-maintainers@googlegroups.com,
73+
the project stewards at Google Quantum AI. They will then work with a committee
74+
consisting of representatives from the Open Source Programs Office and the
75+
Google Open Source Strategy team. If for any reason you are uncomfortable
76+
reaching out to the Project Stewards, please email opensource@google.com.
77+
78+
We will investigate every complaint, but you may not receive a direct response.
79+
We will use our discretion in determining when and how to follow up on reported
80+
incidents, which may range from not taking action to permanent expulsion from
81+
the project and project-sponsored spaces. We will notify the accused of the
82+
report and provide them an opportunity to discuss it before any action is taken.
83+
The identity of the reporter will be omitted from the details of the report
84+
supplied to the accused. In potentially harmful situations, such as ongoing
85+
harassment or threats to anyone's safety, we may take action without notice.
86+
87+
## Attribution
88+
89+
This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
90+
available at
91+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,10 @@ eligible for the [Google Open Source Software Vulnerability Rewards
110110
Program](https://bughunters.google.com/open-source-security).
111111

112112
Copyright 2025 Google LLC.
113+
114+
<div align="center">
115+
<a href="https://quantumai.google">
116+
<img width="15%" alt="Google Quantum AI"
117+
src="./assets/quantum-ai-vertical.svg">
118+
</a>
119+
</div>

SUPPORT.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Support
2+
3+
Thank you for your interest in this project! If you are experiencing problems
4+
or have questions, the following are some suggestions for how to get help.
5+
6+
> [!NOTE]
7+
> Before participating in our community, please read our [code of
8+
> conduct](CODE_OF_CONDUCT.md). By interacting with this repository,
9+
> organization, or community, you agree to abide by its terms.
10+
11+
## Report an issue or request a feature
12+
13+
To report an issue or request a feature, please first search this project's
14+
issue tracker on GitHub to check if there is already an open issue identical or
15+
similar to your bug report/feature request. If there is none, go ahead and file
16+
a new issue in the issue tracker.
17+
18+
## Contact the maintainers
19+
20+
For any questions or concerns not addressed here, please email
21+
quantum-oss-maintainers@google.com.

WORKSPACE

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Copyright 2023 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
115
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
216
load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
317

assets/quantum-ai-vertical.svg

Lines changed: 19 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)