-
Notifications
You must be signed in to change notification settings - Fork 665
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Templates Readme - Github Repo links #5381
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh I see what you mean now. These READMEs are meant to be seen from the perspective of the real fork, not here.
I would say we should generally discourage anyone from cloning the entirety of polkadot-sdk
to use the templates.
So, if anything, I would add the opposite in templates/README.md
that warns users to not use these templates, and instead go to the repos you have linked.
cc @rzadp
I think it makes sense, especially since if you clone a template repo, you would get the code originated from the stable branch - as opposed to cloning the default branch of |
Head branch was pushed to by a user without write access
Noticed the markdownlint check failed. Fixed it now. Hope this can be merged now. https://github.com/paritytech/polkadot-sdk/actions/runs/10734180797/job/29768873243?pr=5381 |
986e7ae
When someone downloads the Polkadot SDK repo and navigates to the templates folder, the Readme instructions do not work. There is a getting started script of the Polkadot SDK readme which can be overlooked (and also it covers only minimal template and not the parachain/solochain templates).
The instructions of the Readme files are updated such that they work for anyone on
https://github.com/paritytech/polkadot-sdk
https://github.com/paritytech/polkadot-sdk-minimal-template
https://github.com/paritytech/polkadot-sdk-parachain-template
https://github.com/paritytech/polkadot-sdk-solochain-template