From 099da507fc0af5a64935d8859dd06ad10a8cdee6 Mon Sep 17 00:00:00 2001 From: Nigel Jones <jonesn@uk.ibm.com> Date: Wed, 6 Mar 2024 12:05:40 +0000 Subject: [PATCH] Add initial process for onboarding Signed-off-by: Nigel Jones <jonesn@uk.ibm.com> --- 2024-04-hackathon.md | 3 ++- project-onboarding.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 project-onboarding.md diff --git a/2024-04-hackathon.md b/2024-04-hackathon.md index d64c5e5..7b605f5 100644 --- a/2024-04-hackathon.md +++ b/2024-04-hackathon.md @@ -39,7 +39,8 @@ For raising issues around pq-code-package generally: ## Onboarding projects - [List of projects & contacts we hope to onboard](candidate-projects) -- getting started with setting up a new project +- [getting started with setting up a new project][project-onboarding] +- Common documentation ## Facilitators diff --git a/project-onboarding.md b/project-onboarding.md new file mode 100644 index 0000000..1a461d7 --- /dev/null +++ b/project-onboarding.md @@ -0,0 +1,35 @@ +# Project Onboarding + +## License Requirements + +- Project source should be either under the Apache-2.0 or MIT license +- Documentation should be CC-BY-4.0 + +## Creating a Github repo + +1. Decide on an initial name for the repo. + + This is expected to be of the form + ``` + algorithm-language[-optionalplatform][-optionaldescriptor] + ``` + for example + ``` + mlkem-assembly-avx2-jasmin + ``` + See [tsc/11](https://github.com/pq-code-package/tsc/issues/11) for discussion + +2. Raise github issue to request repo and access group be created + + - Use the [tsc repo issues](https://github.com/pq-code-package/tsc/issues) to request a new github repository for the project + + - Provide the following information: + - name + - description + - Appropriate access groups: + - initial list of maintainers + - initial list of core contributors + - any other relevant access into + - anything else relevant... + + - Alternatively in the issue specify the source repo to migrate the code from & engage in a discussion as to the best way to acheive this