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

Cleanup README.md #12

Merged
merged 2 commits into from
Aug 13, 2024
Merged

Cleanup README.md #12

merged 2 commits into from
Aug 13, 2024

Conversation

jorgecuesta
Copy link
Collaborator

@jorgecuesta jorgecuesta commented Aug 9, 2024

Summary

Removed all the non-implemented features yet from README.Md

Type of change

Select one or more:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

Documentation changes (only if making doc changes)

  • make docusaurus_start; only needed if you make doc changes

Local Testing (only if making code changes)

  • Unit Tests: make go_develop_and_test
  • LocalNet E2E Tests: make test_e2e
  • See quickstart guide for instructions

PR Testing (only if making code changes)

  • DevNet E2E Tests: Add the devnet-test-e2e label to the PR.
    • THIS IS VERY EXPENSIVE, so only do it after all the reviews are complete.
    • Optionally run make trigger_ci if you want to re-trigger tests without any code changes
    • If tests fail, try re-running failed tests only using the GitHub UI as shown here

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have commented my code
  • I have performed a self-review of my own code; both comments & source code
  • I create and reference any new tickets, if applicable
  • I have left TODOs throughout the codebase, if applicable

@Olshansk Olshansk added the documentation Improvements or additions to documentation label Aug 9, 2024
@Olshansk
Copy link
Member

@jorgecuesta Can you merge this in?
Screenshot 2024-08-12 at 11 40 15 AM

@jorgecuesta
Copy link
Collaborator Author

@jorgecuesta Can you merge this in?
Screenshot 2024-08-12 at 11 40 15 AM

Yes I'm going to update the readme like you ask on discord.

@jorgecuesta jorgecuesta changed the title Fix typo in README.md instructions Cleanup README.md Aug 13, 2024
Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

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

I've opened #13 to track re-integrating the migration piece. In the meantime, this seems reasonable to me. 👍

Thanks for taking the initiative!

@jorgecuesta jorgecuesta merged commit e58c2c1 into main Aug 13, 2024
4 checks passed
@jorgecuesta jorgecuesta deleted the pr-test branch August 13, 2024 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants