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

Documentation updates #10178

Merged
merged 6 commits into from Dec 31, 2020
Merged

Documentation updates #10178

merged 6 commits into from Dec 31, 2020

Conversation

Rylan12
Copy link
Member

@Rylan12 Rylan12 commented Dec 29, 2020

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?
  • Have you successfully run brew man locally and committed any changes?

This PR makes two documentation changes:

  1. Cleanup the text around the cask options in the manpage/documentation. brew cask is now disabled so these options don't apply to its subcommands. Additionally, the cask options are only used in the install, reinstall, and upgrade commands rather than all commands that accept --cask.
  2. Clarifies the Maintainer Guidelines by adding a chart explaining when to use squash & merge versus rebase & merge.

@Rylan12 Rylan12 added the documentation Documentation changes label Dec 29, 2020
@Rylan12 Rylan12 requested a review from samford December 29, 2020 18:05
@BrewTestBot
Copy link
Member

Review period will end on 2020-12-30 at 18:05:01 UTC.

1 similar comment
@BrewTestBot
Copy link
Member

Review period will end on 2020-12-30 at 18:05:01 UTC.

@BrewTestBot BrewTestBot added waiting for feedback Merging is blocked until sufficient time has passed for review and removed waiting for feedback Merging is blocked until sufficient time has passed for review labels Dec 29, 2020
@BrewTestBot
Copy link
Member

Review period ended.

docs/Maintainer-Guidelines.md Outdated Show resolved Hide resolved
docs/Maintainer-Guidelines.md Outdated Show resolved Hide resolved
Co-Authored-By: Sam Ford <1584702+samford@users.noreply.github.com>
@Rylan12 Rylan12 requested a review from samford December 30, 2020 22:20
Co-Authored-By: Sam Ford <1584702+samford@users.noreply.github.com>
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Thanks @Rylan12!

Co-authored-by: Sam Ford <1584702+samford@users.noreply.github.com>
@Rylan12
Copy link
Member Author

Rylan12 commented Dec 31, 2020

Thanks @samford and @MikeMcQuaid for the reviews!

@Rylan12 Rylan12 merged commit 635ecbc into Homebrew:master Dec 31, 2020
@Rylan12 Rylan12 deleted the documentation-updates branch December 31, 2020 19:41
@BrewTestBot BrewTestBot added the outdated PR was locked due to age label Feb 1, 2021
@Homebrew Homebrew locked as resolved and limited conversation to collaborators Feb 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation changes outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants