Make Github Templates

[4meta5]

Problem

This is a known issue wherein the two templates were merged into a single repo and we lost the functionality of github templates.

The current flow for using a template as a jumping off point is clunky and not ideal for users:

1. clone this repo
2. remove template(s) and/or code in this repo that aren't necessary/used

Although it's not difficult to perform the cloning steps, even the most minimal friction may deter initial usage especially at a project's inception.

Ideally, the user could initialize a repo using one of the templates directly via the github templates feature.

Solution

The solution is to split templates into their own separate repos. We will need to discuss this thoroughly because this was the initial organization. From what I remember we merged the templates into the same repo so they could be upgraded to the same polkadot-sdk version more easily. Since then the polkadot-sdk upgrade process has been improved to the point where the repo split would NOT incur any additional work relative to the existing merged repo workflow.

There is precedent for this split organization plus a separate repo for shared documentation (which could be this repo).

[4meta5]

CC @oz-khizer I plan to request the split as follows from IT only once I have fully validated the confidential assets path (WIP). Otherwise this issue is deprioritized to not add too much complexity to initially testing that functionality. The renaming proposed below should be agreed upon by the team and finalized before then:

Proposed split better follows the naming conventions set by other repos under this organization:

• [ ] openzeppelin-polkadot-generic-template: content in new repo = generic-template/
• [ ] openzeppelin-polkadot-evm-template: content in new repo = evm-template/
• [ ] openzeppelin-polkadot-docs: content in new repo = docs/ (rename this repo to openzeppelin-polkadot-docs leaving only the docs subfolder and moving everything else out -- issues should be retained such that the docs repo serves as a meta repo for polkadot tasks in general)

Optional rename to perfectly align with naming conventions set above:

• [ ] openzeppelin-pallet-abstractions should be renamed to openzeppelin-polkadot-abstractions

Other polkadot repos under this org that should ideally match the naming conventions proposed above:

• [ ] $openzeppelin-contracts-polkadot-fork --> openzeppelin-polkadot-contracts (TODO: open yet?)

Moved Into Separate Repos (Done)

• [x] $xcm-intents --> openzeppelin-polkadot-xcm
• [x] openzeppelin-polkadot-zk

[son-oz]

@4meta5 I remembered we briefly discussed this last year. Your proposal makes sense if you think maintaining polkadot-sdk for multiple repos is not an issue anymore. One minor typo in this paragraph I think:

openzeppelin-polkadot-docs: content in new repo = docs/ (rename this repo to openzeppelin-polkadot-docs leaving only the docs subfolder and moving everything else out -- issues should be retained such that the docs repo serves as a meta repo for polkadot tasks in general) And how about this polkadot-evm-runtime-template repo?

[4meta5]

I remembered we briefly discussed this last year. Your proposal makes sense if you think maintaining polkadot-sdk for multiple repos is not an issue anymore.

@son-oz Indeed it is not an issue anymore since we have made improvements to the polkadot-sdk upgrade process since this original decision. Now the maintenance burden is unchanged if we split this repo into multiple templates.

One minor typo in this paragraph I think:

openzeppelin-polkadot-docs: content in new repo = docs/ (rename this repo to openzeppelin-polkadot-docs leaving only the docs subfolder and moving everything else out -- issues should be retained such that the docs repo serves as a meta repo for polkadot tasks in general)

I do not see the typo, where/what is it?

And how about this polkadot-evm-runtime-template repo?

We should ideally delete that repository. I thought I put in a request for deleting that repo before. It is replaced by the evm-template/ in this repository which should be moved into the new repo openzeppelin-polkadot-evm-template

[son-oz]

@4meta5 I re-read that paragraph, do you mean renaming this repo (polkadot-runtime-templates) to openzeppelin-polkadot-docs and its content will only be the files under the current /docs folder?

The polkadot-evm-runtime-template repo still has the OZ Development For Polkadot project attached.

[4meta5]

I re-read that paragraph, do you mean renaming this repo (polkadot-runtime-templates) to openzeppelin-polkadot-docs and its content will only be the files under the current /docs folder?

Yes

...still has project attached

Can we move that project to be attached to the new docs repo as it will serve as the meta repo for polkadot work? If the project needs to be closed out I think that is fine because we weren't using it before much anyway. We can start a new one from scratch as needed CC @oz-khizer

[4meta5]

Closed by merging:

• [ ] #425
• [ ] https://github.com/OpenZeppelin/openzeppelin-polkadot-evm-template/pull/1
• [ ] https://github.com/OpenZeppelin/openzeppelin-polkadot-generic-template/pull/1