diff --git a/2024-04-hackathon.md b/2024-04-hackathon.md deleted file mode 100644 index d885f01..0000000 --- a/2024-04-hackathon.md +++ /dev/null @@ -1,59 +0,0 @@ -[//]: # (SPDX-License-Identifier: CC-BY-4.0) - -# March 2024 hackathon - -The initial hackathon for the post-quantum code package will take place on Tue 12 March. The core times -are below, but given the geographical spread there may be people available before and after these times. - -| Timezone | Start | End | -| --- | --- | --- | -| GMT | 1330 | 2100 | -| CET | 1430 | 2200 | -| EST | 0930 | 1700 | -| PST | 0630 | 1400 | - -## Objective - -Thanks for joining the Hackathon. After all of the interest around the [PQCA](https://pqca.org) launch, we now want to start making it real by onboarding projects: - -* Get contributors for ML-KEM implementations together to kick-start the pq-code-package project. -* Create github repos with appropriate teams, permissions. -* Start populating those repos with code -* Get initial build/compiles working & continue with any additional ci activities such as security scans -* Start documenting the project -* Bring the community together for real-time discussions and help to make this real - -## Collaboration - -During the session core times we will have a video conference active: -- [zoom](https://zoom.us/j/97821311660?pwd=My9rWVRkbHJXbEJHQVc5TGlkNFpyZz09) - -There's also a variety of chat channels: - - [Discord](https://discord.com/channels/1202723482224295936/1203396039977996359) - if needed you can [signup here](https://discord.com/invite/xyVnwzfg5R) - - [Github discussions](https://github.com/orgs/pq-code-package/discussions) - -For raising issues around pq-code-package generally: - - [TSC issues](https://github.com/pq-code-package/tsc) - - Finally as projects onboard, issues can be raised in their own repositories. - -## Onboarding projects - -- [List of projects & contacts we hope to onboard](candidate-projects.md) -- [Github project creation](project-onboarding.md) -- [source code requirements](source-requirements.md) -- [code scanning](code-scanning.md) -- Common documentation - -## Other useful links - -- [Post Quantum Cryptography Alliance](https://pqca.org) -- [Open Quantum Safe](https://openquantumsafe.org/) - -## Facilitators - -If you have any issues, concerns or questions that can't be resolved from the above, please do contact: - -| Name | email | discord | github | Role | -| --- | --- | --- | --- | --- | -| Nigel Jones | jonesn@uk.ibm.com | planetf1 | planetf1 | Software Engineer @ IBM | \ No newline at end of file diff --git a/202404/2024-04-hackathon.md b/202404/2024-04-hackathon.md new file mode 100644 index 0000000..bd86169 --- /dev/null +++ b/202404/2024-04-hackathon.md @@ -0,0 +1,73 @@ +[//]: # (SPDX-License-Identifier: CC-BY-4.0) + +# March 2024 hackathon + +The initial hackathon for the post-quantum code package will take place on Tue 12 March. + + + +## Objective + +We aim to make the [pq-code-package project](https://github.com/pq-code-package) the place to come to for trusted post-quantum standards-oriented cryptographic algorithm implementations. + +An important step towards this is to start onboarding [candidate ML-KEM implementations](candidate-projects.md) and making them available in the project: + + +* Bring anyone interested in ML-KEM implementations together to share ideas +* Create Github repos to manage implementations, and populate these repos with implementation code. +* Get initial ci in place for policy checks, static/security scans,build, test. +* Documenting the project including implementation summaries explaining the characteristics of different implementations. +* Learn from our initial implementations to get an 'examplar' for future implementations. + + +These are just some initial ideas. This is intended as an open collaboration session and any ideas on how we can effectively use the time are welcome! + +## Live session + +The core times +are below, but given the geographical spread there may be people available before and after these times. + +| Timezone | Start | End | +| --- | --- | --- | +| GMT | 1330 | 2100 | +| CET | 1430 | 2200 | +| EST | 0930 | 1700 | +| PST | 0630 | 1400 | + +During the session core times we will have a [Zoom video conference](https://zoom.us/j/97821311660?pwd=My9rWVRkbHJXbEJHQVc5TGlkNFpyZz09). + +There's also a variety of chat channels: + - [Discord](https://discord.com/channels/1202723482224295936/1203396039977996359) - if needed you can [signup here](https://discord.com/invite/xyVnwzfg5R) + - [Github discussions](https://github.com/orgs/pq-code-package/discussions) + +For raising issues around pq-code-package generally: + - [TSC issues](https://github.com/pq-code-package/tsc) + + As projects onboard, issues can be raised in their own repositories. + +## Onboarding projects + +- [Licensing/Legal](licensing.md) +- [Github repository](project-onboarding.md) +- [source code requirements](source-requirements.md) +- [build & ci](code-scanning.md) +- [Documentation][docs.md] + +## What next? + +* look at what went well, and less well during the hackathon, so we can consider running future events +* continue onboarding & developing the hosted projects +* get up and running with a more formal governance model + +## Other useful links + +- [Post Quantum Cryptography Alliance](https://pqca.org) +- [Open Quantum Safe](https://openquantumsafe.org/) + +## Facilitators + +If you have any issues, concerns or questions that can't be resolved from the above, please do contact: + +| Name | email | discord | github | Role | +| --- | --- | --- | --- | --- | +| Nigel Jones | jonesn@uk.ibm.com | planetf1 | planetf1 | Software Engineer @ IBM | \ No newline at end of file diff --git a/candidate-projects.md b/202404/candidate-projects.md similarity index 100% rename from candidate-projects.md rename to 202404/candidate-projects.md diff --git a/code-scanning.md b/202404/code-scanning.md similarity index 100% rename from code-scanning.md rename to 202404/code-scanning.md diff --git a/202404/licensing.md b/202404/licensing.md new file mode 100644 index 0000000..7b4c79d --- /dev/null +++ b/202404/licensing.md @@ -0,0 +1,21 @@ +# Licensing + +Projects onboarded should be licensed under: + +| SPDX Tag | Example | Used for | +| --- | --- | --- | +Apache-2.0 | | Source code| +CC-BY-4.0 | | Documentation + +For another other license, legal approval is required. + +## Source files + +All source code should contain SPDX license headers where possible: + + +* https://spdx.dev/learn/handling-license-info/ for more documentation +* https://spdx.org/licenses/ has a full list of labels + +This helps with automated checks and other processes. + diff --git a/project-onboarding.md b/202404/project-onboarding.md similarity index 100% rename from project-onboarding.md rename to 202404/project-onboarding.md diff --git a/source-requirements.md b/202404/source-requirements.md similarity index 100% rename from source-requirements.md rename to 202404/source-requirements.md diff --git a/202404/standard-files.md b/202404/standard-files.md new file mode 100644 index 0000000..4652fb0 --- /dev/null +++ b/202404/standard-files.md @@ -0,0 +1,21 @@ +# Source code requirements + +## Licensing + +All source code should contain SPDX license headers. + + +* https://spdx.dev/learn/handling-license-info/ for more documentation +* https://spdx.org/licenses/ has a full list of labels + +The following are ok to use, others need legal review + +| SPDX Tag | Example | Used for | +| --- | --- | --- | +Apache-2.0 | | Source code| +CC-BY-4.0 | | Documentation + +## Required files + +| File | Description | +| -- | -- | \ No newline at end of file diff --git a/index.md b/index.md index 5458274..7f243de 100644 --- a/index.md +++ b/index.md @@ -3,7 +3,7 @@ # PQ-Code-Package Hackathons If you're aware our upcoming Hackathon, jump straight in. If not, read on ... -* [2024 04 hackathon](2024-04-hackathon.md) - Tue 12 April 2024 +* [2024 04 hackathon](202404/2024-04-hackathon.md) - Tue 12 April 2024 ## About the PQCA @@ -38,4 +38,4 @@ The next tangible step in this journey is to start on-boarding projects & bring To get focussed on this we've setup our initial hackathon & look forward to making great progress -[Head over to the 2024 04 Hackathon page](2024-04-hackathon.md) \ No newline at end of file +[Head over to the 2024 04 Hackathon page](202404/2024-04-hackathon.md) \ No newline at end of file