Skip to content

Adding/updating READMEs #362

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Adding/updating READMEs #362

wants to merge 2 commits into from

Conversation

carstenjacobsen
Copy link
Contributor

What

  1. Updating the root README
  2. Adding a short README to each contract

Why

  1. Added description of new contracts, and fixed a markdown issue
  2. Adding individual READMEs to each contract. The purpose to add a short description, test instructions and useful links, so if devs are looking at a specific example contract, then there's easy access to relevant info and links

@leighmcculloch leighmcculloch requested review from a team and removed request for leighmcculloch February 20, 2025 19:04
fnando
fnando approved these changes Feb 20, 2025
View reviewed changes
Copy link
Member

@fnando fnando left a comment

Choose a reason for hiding this comment

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

This is amazing! 🤩

jeesunikim
jeesunikim reviewed Feb 20, 2025
View reviewed changes
@jeesunikim
Copy link

@carstenjacobsen some of the examples are using outdated gitpod. they should be using v22.0.1?

jeesunikim
jeesunikim reviewed Feb 20, 2025
View reviewed changes
jeesunikim
jeesunikim reviewed Feb 20, 2025
View reviewed changes
ifropc
ifropc approved these changes Feb 20, 2025
View reviewed changes
Copy link
Contributor

@ifropc ifropc left a comment

Choose a reason for hiding this comment

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

Amazing work, thank you @carstenjacobsen !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeesunikim jeesunikim jeesunikim left review comments

@fnando fnando fnando approved these changes

+1 more reviewer

@ifropc ifropc ifropc approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@carstenjacobsen @jeesunikim @fnando @ifropc