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

starship: add a caveat with installation instructions #42977

Closed
wants to merge 1 commit into from

Conversation

@matchai
Copy link
Contributor

commented Aug 9, 2019

  • Have you followed the guidelines for contributing?
  • Have you checked that there aren't other open pull requests for the same formula update/change?
  • Have you built your formula locally with brew install --build-from-source <formula>, where <formula> is the name of the formula you're submitting?
  • Is your test running fine brew test <formula>, where <formula> is the name of the formula you're submitting?
  • Does your build pass brew audit --strict <formula> (after doing brew install <formula>)?

@SMillerDev

This comment has been minimized.

Copy link
Member

commented Aug 10, 2019

Those instructions aren't homebrew specific. So they should be documented by upstream.

@matchai

This comment has been minimized.

Copy link
Contributor Author

commented Aug 10, 2019

It appears to me that quite a few other formulae use caveats to document installation instructions, for example nvm. Is that not the suggested approach?

@SMillerDev

This comment has been minimized.

Copy link
Member

commented Aug 10, 2019

Only if there is something homebrew specific in the procedure. See: https://docs.brew.sh/Formula-Cookbook#caveats

@matchai matchai closed this Aug 10, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.