Skip to content

Add README to project root#1253

Merged
ggwpez merged 9 commits intomasterfrom
wentelteefje-add-root-readme
Aug 31, 2023
Merged

Add README to project root#1253
ggwpez merged 9 commits intomasterfrom
wentelteefje-add-root-readme

Conversation

@wentelteefje
Copy link
Copy Markdown
Contributor

@wentelteefje wentelteefje commented Aug 29, 2023 •
edited
Loading

This PR adds a README for the polkadot-sdk root. It's merely a first draft, so please share your thoughts and suggestions.

A few ideas for improvement and general notes include:

  • It would be great to include relevant badges (e.g., build status, license) beneath each of the three project headings, if feasible.
  • Given that this is now our primary community-facing repository, I believe it's crucial for us to have a distinctive logo. I'm fond of the parachain visualization. While it serves as a suitable placeholder for now, we should consider replacing it with a more permanent image in the future.
  • Adding a paragraph about community resources would be good too, alternatively this can also be solved by adding badges to each of the three projects headings. However, we need to determine which websites or platforms we'd prefer to highlight and link to in this context.

@wentelteefje wentelteefje added the T11-documentation This PR/Issue is related to documentation. label Aug 29, 2023
ggwpez
ggwpez reviewed Aug 29, 2023
View reviewed changes
README.md

### [Cumulus](./cumulus/)
Cumulus is a set of tools for writing Substrate-based Polkadot parachains.

Copy link
Copy Markdown
Member

@ggwpez ggwpez Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if we need to mention licensing, but many projects do.
Each crate should have its own licensing information attached in the Cargo.toml and everythin else is GPL-3.0-only i assume?

Copy link
Copy Markdown
Contributor Author

@wentelteefje wentelteefje Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm unsure about possible legal requirements -- but my suggestion is to add appropriate badges, e.g. like in the substrate readme. This is somewhat redundant, but I also think it's poor UX to be required to jump to all of the respective readme's to get that info.

Copy link
Copy Markdown
Contributor

@gilescope gilescope Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should copy the licensing blurb from the substrate readme I would think.

Copy link
Copy Markdown
Contributor Author

@wentelteefje wentelteefje Aug 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should copy the licensing blurb from the substrate readme I would think.

I've added badges to each project to reflect their respective licenses. I don't think it's really necessary to explain Substrate's split license in depth in the root readme. Am I missing something?

gilescope
gilescope reviewed Aug 29, 2023
View reviewed changes
gilescope
gilescope reviewed Aug 29, 2023
View reviewed changes
ggwpez
ggwpez reviewed Aug 30, 2023
View reviewed changes
ggwpez
ggwpez reviewed Aug 30, 2023
View reviewed changes
@wentelteefje wentelteefje force-pushed the wentelteefje-add-root-readme branch from a916c7e to 5bec330 Compare August 30, 2023 11:50
ggwpez
ggwpez approved these changes Aug 30, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@ggwpez ggwpez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep looks good, thank you!
(just one more nit)

gilescope
gilescope approved these changes Aug 31, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@gilescope gilescope left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's time to put the readme on the repo.

@ggwpez
Copy link
Copy Markdown
Member

ggwpez commented Aug 31, 2023

Also want to have a look @bkchr? Otherwise going to merge soon.

@bkchr
Copy link
Copy Markdown
Member

bkchr commented Aug 31, 2023

Also want to have a look @bkchr? Otherwise going to merge soon.

Merge as you like

@ggwpez ggwpez enabled auto-merge (squash) August 31, 2023 17:28
@ggwpez ggwpez merged commit ea57925 into master Aug 31, 2023
@ggwpez ggwpez deleted the wentelteefje-add-root-readme branch August 31, 2023 17:45
ordian added a commit that referenced this pull request Sep 1, 2023
@ordian
Merge branch 'master' into s0me0ne/candidate-session-index
40e3da9 
* master: (25 commits)
  fix typos (#1339)
  Use bandersnatch-vrfs with locked dependencies ref (#1342)
  Bump bs58 from 0.4.0 to 0.5.0 (#1293)
  Contracts: `seal0::balance` should return the free balance (#1254)
  Logs: add extra debug log for negative rep changes (#1205)
  Added short-benchmarks for cumulus (#1183)
  [xcm-emulator] Improve hygiene and clean up (#1301)
  Bump the known_good_semver group with 1 update (#1347)
  Renames API (#1186)
  Rename `polkadot-parachain` to `polkadot-parachain-primitives` (#1334)
  Add README to project root (#1253)
  Add environmental variable to track decoded instructions (#1320)
  Fix polkadot-node-core-pvf-prepare-worker build with jemalloc (#1315)
  Sassafras primitives (#1249)
  Restructure `dispatch` macro related exports (#1162)
  backing: move the min votes threshold to the runtime (#1200)
  Bump zstd from 0.11.2+zstd.1.5.2 to 0.12.4 (#1326)
  Remove `substrate_test_utils::test` (#1321)
  remove disable-runtime-api (#1328)
  [ci] add more jobs for pipeline cancel, cleanup (#1314)
  ...
Daanvdplas pushed a commit that referenced this pull request Sep 11, 2023
@wentelteefje @gilescope
@ggwpez @Daanvdplas
Add README to project root (#1253)
5179886 
* Added root README.md draft

* Modified Contribution section to reflect unified guidelines

* Update README.md

Co-authored-by: Squirrel <gilescope@gmail.com>

* Expand Substrate description

* Added Badges and Upstream deps

* Fixed badge links

* Fixed CONTRIBUTING.md links, added security and resources section to root README.md

* Moved runtimes link to Polkadot section

---------

Co-authored-by: Squirrel <gilescope@gmail.com>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
@crystalin crystalin mentioned this pull request Oct 20, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@the-right-joyce the-right-joyce the-right-joyce left review comments

@franciscoaguirre franciscoaguirre franciscoaguirre approved these changes

@ggwpez ggwpez ggwpez approved these changes

+1 more reviewer

@gilescope gilescope gilescope approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

T11-documentation This PR/Issue is related to documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@wentelteefje @ggwpez @bkchr @gilescope @franciscoaguirre @the-right-joyce