Skip to content

Commit 6e2b59c

Browse files
planetf1planetf1
authored
Merge pull request #1 from planetf1/main
2 parents bb1c417 + 6ecedf8 commit 6e2b59c

File tree

13 files changed

+181
-0
lines changed

13 files changed

+181
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
[//]: # (SPDX-License-Identifier: CC-BY-4.0)
2+
[//]: # (TODO Customize Issue templates)
3+
4+
[//]: # (See https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
5+
---
6+
name: Bug report
7+
about: Create a report to help us improve
8+
title: ''
9+
labels: ''
10+
assignees: ''
11+
12+
---
13+
14+
**Describe the bug**
15+
A clear and concise description of what the bug is.
16+
17+
**To Reproduce**
18+
Steps to reproduce the behavior:
19+
1. Go to '...'
20+
2. Click on '....'
21+
3. Scroll down to '....'
22+
4. See error
23+
24+
**Expected behavior**
25+
A clear and concise description of what you expected to happen.
26+
27+
**Screenshots**
28+
If applicable, add screenshots to help explain your problem.
29+
30+
**Environment (please complete the following information):**
31+
- OS: [e.g. Ubuntu 20]
32+
- OpenSSL version [e.g., 3.0.2]
33+
- Compiler version used [e.g., clang 9.0.0]
34+
- Build variables used [e.g., "-DOQS_ALGS_ENABLED=STD"]
35+
- liboqs version [e.g. 0.7.2 or main branch]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/pull_request_template.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[//]: # (SPDX-License-Identifier: CC-BY-4.0)
2+
[//]: # (TODO Customize PR template)
3+
4+
[//]: # (See https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository )
5+
6+
<!-- Please give a brief explanation of the purpose of this pull request. -->
7+
8+
<!-- Does this PR resolve any issue? If so, please reference it using automatic-closing keywords like "Fixes #123." -->
9+
10+
<!-- Any PR adding a new feature is expected to contain a test; the test should be part of CI testing, preferably within the ".github/workflows" directory tree. Please add an explanation to the PR if/when (why) this cannot be done. -->
11+
12+
<!-- Please answer the following questions to help manage version and changes across projects. -->
13+
14+
* [ ] Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from *x.y.z* to *x.(y+1).0*.)
15+
16+
<!-- Once your pull request is ready for review and passing continuous integration tests, please convert from a draft PR to a normal PR, and request a review from one of the OQS core team members. -->

‎.github/workflows/scorecard.yaml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# SPDX-License-Identifier: Apache-2.0
2+
3+
name: OSSF Scorecard analysis
4+
on:
5+
# Only the default branch is supported.
6+
branch_protection_rule:
7+
schedule:
8+
# Weekly on Saturdays.
9+
- cron: '30 1 * * 6'
10+
push:
11+
branches: [ main ]
12+
13+
# Declare default permissions as read only.
14+
permissions: read-all
15+
16+
jobs:
17+
analysis:
18+
name: Scorecard analysis
19+
runs-on: ubuntu-latest
20+
permissions:
21+
# Needed if using Code scanning alerts
22+
security-events: write
23+
# Needed for GitHub OIDC token if publish_results is true
24+
id-token: write
25+
26+
steps:
27+
- name: "Checkout code"
28+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
29+
with:
30+
persist-credentials: false
31+
32+
- name: "Run analysis"
33+
uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
34+
with:
35+
results_file: results.sarif
36+
results_format: sarif
37+
# (Optional) fine-grained personal access token. Uncomment the `repo_token` line below if:
38+
# - you want to enable the Branch-Protection check on a *public* repository, or
39+
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-fine-grained-pat-optional.
40+
# repo_token: ${{ secrets.SCORECARD_TOKEN }}
41+
42+
# Publish the results for public repositories to enable scorecard badges. For more details, see
43+
# https://github.com/ossf/scorecard-action#publishing-results.
44+
# For private repositories, `publish_results` will automatically be set to `false`, regardless
45+
# of the value entered here.
46+
publish_results: true
47+
48+
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
49+
# format to the repository Actions tab.
50+
- name: "Upload artifact"
51+
uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
52+
with:
53+
name: SARIF file
54+
path: results.sarif
55+
retention-days: 5
56+
57+
# required for Code scanning alerts
58+
- name: "Upload SARIF results to code scanning"
59+
uses: github/codeql-action/upload-sarif@592977e6ae857384aa79bb31e7a1d62d63449ec5 # v2.16.3
60+
with:
61+
sarif_file: results.sarif

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# SPDX-License-Identifier: Apache-2.0
2+
# (TODO customize .gitignore for project)
3+
4+
.vscode
5+
.idea

‎CODEOWNERS‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SPDX-License-Identifier: Apache-2.0
2+
# TODO Update code owners
3+
4+
# Last matching pattern has precedence
5+
6+
# Default owner
7+
* @pq-code-package/pqcp-hackers
8+

‎CODE_OF_CONDUCT.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[//]: # (SPDX-License-Identifier: CC-BY-4.0)
2+
[//]: # (TODO Add code of conduct)
3+
4+
# Code of Conduct
5+
6+
Please see [open issue](https://github.com/pq-code-package/tsc/issues/9)

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[//]: # (SPDX-License-Identifier: CC-BY-4.0)
2+
[//]: # (TODO Add contributing guide)
3+
4+
# Contributing
5+
6+
to be completed

‎GOVERNANCE.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[//]: # (SPDX-License-Identifier: CC-BY-4.0)
2+
[//]: # (TODO Define governance)
3+
4+
# Governance
5+
6+
to be documented

‎MAINTAINERS.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[//]: # (SPDX-License-Identifier: CC-BY-4.0)
2+
[//]: # (TODO Update list of maintainers)
3+
4+
# Maintainers
5+
6+
## Active Maintainers
7+
8+
| Name | GitHub | Chat | Affliation
9+
|-------------------------|-------------------------------------------|----------------|----------------------
10+
| Nigel Jones | [planetf1](https://github.com/planetf1) | planetf1 | IBM
11+

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,6 @@
1+
[//]: # (SPDX-License-Identifier: CC-BY-4.0)
2+
[//]: # (TODO Customize project readme)
3+
14
# template-code
5+
26
Template for creating code repositories, with basic file setup included

0 commit comments

Comments
 (0)