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

readme: clarify that usage is about main branch #376

Merged
merged 1 commit into from
Oct 20, 2022
Merged

Conversation

metachris
Copy link
Collaborator

πŸ“ Summary

  • Make it clear in the README that the usage instructions reflect the main branch, not the latest release
  • Add generating usage to release instructions

βœ… I have run these commands

  • make lint
  • make test-race
  • go mod tidy

@codecov-commenter
Copy link

codecov-commenter commented Oct 19, 2022

Codecov Report

Merging #376 (36be409) into main (94ddac1) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #376   +/-   ##
=======================================
  Coverage   81.75%   81.75%           
=======================================
  Files           5        5           
  Lines         685      685           
=======================================
  Hits          560      560           
  Misses         96       96           
  Partials       29       29           
Flag Coverage Ξ”
unittests 81.75% <ΓΈ> (ΓΈ)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Collaborator

@jtraglia jtraglia left a comment

Choose a reason for hiding this comment

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

LGTM πŸ‘ though, personally, I don't think the help output should be in the readme.

@metachris
Copy link
Collaborator Author

Maybe we should remove the help output from the readme and only have it in the releases. But i've heard from the community that this seems useful, although confusing if it doesn't match the latest release. But this still applies to the other usage instructions as well πŸ€”

If you feel strongly about removing the help output from the readme, them please open a PR, and add a link to the releases page in the readme with the note that cli usage instructions are found there. i think i agree that this would be the better choice πŸ™

@metachris metachris merged commit b37bc8a into main Oct 20, 2022
@metachris metachris deleted the readme-docs branch October 20, 2022 12:01
screwyprof pushed a commit to screwyprof/mev-boost that referenced this pull request Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants