Skip to content

Commit

Permalink
Update hackathon repo with notes from first session
Browse files Browse the repository at this point in the history
Signed-off-by: Nigel Jones <[email protected]>
  • Loading branch information
planetf1 committed Mar 19, 2024
1 parent d33464e commit 7f0c9fd
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 3 deletions.
8 changes: 7 additions & 1 deletion 202404/2024-04-hackathon.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,16 @@

# March 2024 hackathon

The initial hackathon for the post-quantum code package will take place on Tue 12 March. [QUICKSTART](quickstart.md)
The initial hackathon for the post-quantum code package took place on Tue 12 March. [QUICKSTART](quickstart.md)

[Notes from the hackathon are available](summary.md)


The remainder of this content is left for posterity...

<hr>
<hr>

## 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.
Expand Down
57 changes: 57 additions & 0 deletions 202404/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# 2024-04 Hackathon summary

## Top achievements
* Initial onboarding of 4 MLKEM implementation repositories
* 14 contributors

## New org members

Hoping not to miss anyone out, these are the people added to the org (github ids) as maintainers/contributors to the projects below
- mkannwischer
- planetf1
- dstebila
- rpls
- MQuaresma
- ajbozarth
- cryptojedi
- franziskuskiefer
- jschanck
- karthikbhargavan
- mbbarbosa
- potsrevennil
- tfaoliveira
- ashman-p

Others who helped out in du Hart & Ry (LF) & Max.


## Repository activity

| repository | activity during hackathon |
| -- | -- |
| tsc | Record requests for new repo/teams/access|
| mlkem-c-embedded | Created repo and teams<br>Code added - Based on pqm4 repo<br>|
| mlkem-c-generic | Created repo and teams<br>Awaiting code|
| mklkem-libjade | Created repo and teams<br>Awaiting code|
| mlkem-rust-libcrux | Created repo and teams<br>Awaiting code|
| mlkem-c-aarch64 | Created repo and teams after hackathon|
| documentation | mkdocs-material <br>[https://docs.pqcodepackage.org](https://docs.pqcodepackage.org/latest/) |
| template-code | Standard files<br>README, CODEOWNERS<br>scorecard action|
| pq-code-package-hackathon | mini site with links<br>[https://hackathon.pqcodepackage.org](https://hackathon.pqcodepackage.org)|


## Additional points

- Licensing. Aiming for Apache 2.0 (code) & CC-BY-4.0 (docs). some followups
- Test vectors being investigated - license unknowns (Norm Ashley)
- code flow ?upstream -> pqcp -> liboqs. Pipelines/strategy
- need to have commonality across sub-projects. Swap in/out algorithms. Documentation describing characteristics of implementation
- What is a package?
- artifact Distribution to repositories (->github)
- github practices - merge/rebase/squash, versioning, forks
- Managing access control groups was redious. post session adopted tooling to help (defined in yaml)

## Next steps
- TSC formation
- continued onboarding & addressing issues
- another hackathon?
5 changes: 3 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

# PQ-Code-Package Hackathons

If you're aware our upcoming Hackathon, jump straight in. If not, read on ...
* [2024 04 hackathon](202404/2024-04-hackathon.md) - Tue 12 April 2024
Quickly jump to past & upcoming sessions:

* [2024-04-12](202404/2024-04-hackathon.md)

## About the PQCA

Expand Down

0 comments on commit 7f0c9fd

Please sign in to comment.