Skip to content
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

Merged
merged 8 commits into from
Sep 6, 2024
Merged

Conversation

DrW3RK
Copy link
Contributor

@DrW3RK DrW3RK commented Aug 16, 2024

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

Copy link
Contributor

@kianenigma kianenigma left a 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

@rzadp
Copy link
Contributor

rzadp commented Aug 19, 2024

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.

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 polkadot-sdk and getting the templates from there.

@bkchr bkchr added the R0-silent Changes should not be mentioned in any release notes label Aug 25, 2024
@bkchr bkchr enabled auto-merge August 25, 2024 22:12
auto-merge was automatically disabled September 6, 2024 07:51

Head branch was pushed to by a user without write access

@DrW3RK
Copy link
Contributor Author

DrW3RK commented Sep 6, 2024

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

@bkchr bkchr enabled auto-merge September 6, 2024 08:04
@bkchr bkchr added this pull request to the merge queue Sep 6, 2024
Merged via the queue into paritytech:master with commit 986e7ae Sep 6, 2024
203 of 206 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants