diff --git a/202404/project-onboarding.md b/202404/project-onboarding.md index f960a4b..6ad2cbf 100644 --- a/202404/project-onboarding.md +++ b/202404/project-onboarding.md @@ -7,32 +7,18 @@ Any other license will need legal approval -## 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... +## Requesting a Github repo + +1. Decide on an initial name for the repo (see [tsc/11](https://github.com/pq-code-package/tsc/issues/11)) of the form `algorithm-language[-optionalplatform][-optionaldescriptor]`, for example `mlkem-assembly-avx2-jasmin` + +2. Use the [tsc repo issues](https://github.com/pq-code-package/tsc/issues) to request a repository for the implementation including: + - name + - description + - Appropriate access groups: + - admins + - maintainers + - core contributors + - 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 achieve this