From 8c6aa176f6015e681623430294e291de904275aa Mon Sep 17 00:00:00 2001 From: Ryan Schumacher Date: Thu, 29 Aug 2024 05:17:26 -0500 Subject: [PATCH 1/9] Add note about auditor to How-To-Open-a-Homebrew-Pull-Request.md --- docs/How-To-Open-a-Homebrew-Pull-Request.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 0309b7b755..1941e6d0d5 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -16,6 +16,15 @@ The type of change you want to make influences which of Homebrew's main reposito ### Core `brew` code pull request +Before getting started, please note that we cannot distribute every single piece of software and have to draw a line on “notability” somewhere. Of course, we would be happy to reconsider in the future. If you don't meet notability requirements you might consider [creating your own tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap). + +Notability [auditor](https://github.com/Homebrew/brew/blob/638a3dc3a33c4c2029db058cf3d399008621e973/Library/Homebrew/utils/shared_audits.rb) will fail on repositories that do not meet: + +- **>29** days old +- **>29** forks +- **>29** watchers (Github only) +- **>74** stars + 1. [Fork the Homebrew/brew repository on GitHub](https://github.com/Homebrew/brew/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. 2. Change to the directory containing your Homebrew installation: From 5fb6a8b8e31024cd25fac2797a860d58d2c8a078 Mon Sep 17 00:00:00 2001 From: Ryan Schumacher Date: Thu, 29 Aug 2024 08:17:22 -0500 Subject: [PATCH 2/9] Add link to Acceptable Formulae and slight wording change for more clarity. --- docs/How-To-Open-a-Homebrew-Pull-Request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 1941e6d0d5..1a9905eb11 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -16,7 +16,7 @@ The type of change you want to make influences which of Homebrew's main reposito ### Core `brew` code pull request -Before getting started, please note that we cannot distribute every single piece of software and have to draw a line on “notability” somewhere. Of course, we would be happy to reconsider in the future. If you don't meet notability requirements you might consider [creating your own tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap). +Before getting started, please read the [Acceptable Formulae](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Formulae.md) and note that we cannot distribute every single piece of software and have to draw a line on “notability” somewhere. If you don't meet notability requirements you might consider [creating your own tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap). Of course, we would be happy to reconsider in the future! Notability [auditor](https://github.com/Homebrew/brew/blob/638a3dc3a33c4c2029db058cf3d399008621e973/Library/Homebrew/utils/shared_audits.rb) will fail on repositories that do not meet: From ff8b3f21f931e01a2cbff4d9445c81fc425fc599 Mon Sep 17 00:00:00 2001 From: Ryan Schumacher Date: Thu, 29 Aug 2024 08:19:34 -0500 Subject: [PATCH 3/9] Move to appropriate section and resolve lint error --- docs/How-To-Open-a-Homebrew-Pull-Request.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 1a9905eb11..1b1d039102 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -16,15 +16,6 @@ The type of change you want to make influences which of Homebrew's main reposito ### Core `brew` code pull request -Before getting started, please read the [Acceptable Formulae](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Formulae.md) and note that we cannot distribute every single piece of software and have to draw a line on “notability” somewhere. If you don't meet notability requirements you might consider [creating your own tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap). Of course, we would be happy to reconsider in the future! - -Notability [auditor](https://github.com/Homebrew/brew/blob/638a3dc3a33c4c2029db058cf3d399008621e973/Library/Homebrew/utils/shared_audits.rb) will fail on repositories that do not meet: - -- **>29** days old -- **>29** forks -- **>29** watchers (Github only) -- **>74** stars - 1. [Fork the Homebrew/brew repository on GitHub](https://github.com/Homebrew/brew/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. 2. Change to the directory containing your Homebrew installation: @@ -43,6 +34,15 @@ Notability [auditor](https://github.com/Homebrew/brew/blob/638a3dc3a33c4c2029db0 ### Formulae-related pull request +Before getting started with a new formulae, please read the [Acceptable Formulae](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Formulae.md) and note that we cannot distribute every single piece of software and have to draw a line on “notability” somewhere. If you don't meet notability requirements you might consider [creating your own tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap). Of course, we would be happy to reconsider in the future! + +Notability [auditor](https://github.com/Homebrew/brew/blob/638a3dc3a33c4c2029db058cf3d399008621e973/Library/Homebrew/utils/shared_audits.rb) will fail on repositories that do not meet: + +* **>29** days old +* **>29** forks +* **>29** watchers (Github only) +* **>74** stars + 1. [Fork the Homebrew/homebrew-core repository on GitHub](https://github.com/Homebrew/homebrew-core/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. 2. Tap (download a local clone of) the repository of core Homebrew formulae: From f119b4a6d0968a8e4c1edb73f070ee76f7b7af8f Mon Sep 17 00:00:00 2001 From: Ryan Schumacher Date: Thu, 29 Aug 2024 08:28:18 -0500 Subject: [PATCH 4/9] Added the block for casks --- docs/How-To-Open-a-Homebrew-Pull-Request.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 1b1d039102..4f3af9639a 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -67,6 +67,15 @@ Notability [auditor](https://github.com/Homebrew/brew/blob/638a3dc3a33c4c2029db0 ### Cask-related pull request +Before getting started with a new cask, please read the [Acceptable Casks](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Casks.md) and note that we cannot distribute every single piece of software and have to draw a line on “notability” somewhere. If you don't meet notability requirements you might consider [creating your own tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap) (casks can also be installed from a tap). Of course, we would be happy to reconsider in the future! + +Notability [auditor](https://github.com/Homebrew/brew/blob/638a3dc3a33c4c2029db058cf3d399008621e973/Library/Homebrew/utils/shared_audits.rb) will fail on repositories that do not meet: + +* **>29** days old +* **>29** forks +* **>29** watchers (Github only) +* **>74** stars + 1. [Fork the Homebrew/homebrew-cask repository on GitHub](https://github.com/Homebrew/homebrew-cask/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. 2. Tap (download a local clone of) the repository of core Homebrew casks: From 010304a9a115c555e47072f280cbb8734452dc22 Mon Sep 17 00:00:00 2001 From: Ryan Schumacher Date: Thu, 29 Aug 2024 08:48:39 -0500 Subject: [PATCH 5/9] Update docs/How-To-Open-a-Homebrew-Pull-Request.md Co-authored-by: Mike McQuaid --- docs/How-To-Open-a-Homebrew-Pull-Request.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 4f3af9639a..bc80431c04 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -34,15 +34,7 @@ The type of change you want to make influences which of Homebrew's main reposito ### Formulae-related pull request -Before getting started with a new formulae, please read the [Acceptable Formulae](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Formulae.md) and note that we cannot distribute every single piece of software and have to draw a line on “notability” somewhere. If you don't meet notability requirements you might consider [creating your own tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap). Of course, we would be happy to reconsider in the future! - -Notability [auditor](https://github.com/Homebrew/brew/blob/638a3dc3a33c4c2029db058cf3d399008621e973/Library/Homebrew/utils/shared_audits.rb) will fail on repositories that do not meet: - -* **>29** days old -* **>29** forks -* **>29** watchers (Github only) -* **>74** stars - +Before creating a new formulae, please read [Acceptable Formulae](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Formulae.md). 1. [Fork the Homebrew/homebrew-core repository on GitHub](https://github.com/Homebrew/homebrew-core/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. 2. Tap (download a local clone of) the repository of core Homebrew formulae: From 72f995599da70dac3cf192a43fb4397c2ba2e9e1 Mon Sep 17 00:00:00 2001 From: Ryan Schumacher Date: Thu, 29 Aug 2024 08:48:45 -0500 Subject: [PATCH 6/9] Update docs/How-To-Open-a-Homebrew-Pull-Request.md Co-authored-by: Mike McQuaid --- docs/How-To-Open-a-Homebrew-Pull-Request.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index bc80431c04..417704bd26 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -59,15 +59,7 @@ Before creating a new formulae, please read [Acceptable Formulae](https://github ### Cask-related pull request -Before getting started with a new cask, please read the [Acceptable Casks](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Casks.md) and note that we cannot distribute every single piece of software and have to draw a line on “notability” somewhere. If you don't meet notability requirements you might consider [creating your own tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap) (casks can also be installed from a tap). Of course, we would be happy to reconsider in the future! - -Notability [auditor](https://github.com/Homebrew/brew/blob/638a3dc3a33c4c2029db058cf3d399008621e973/Library/Homebrew/utils/shared_audits.rb) will fail on repositories that do not meet: - -* **>29** days old -* **>29** forks -* **>29** watchers (Github only) -* **>74** stars - +Before creating a new cask, please read [Acceptable Casks](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Casks.md). 1. [Fork the Homebrew/homebrew-cask repository on GitHub](https://github.com/Homebrew/homebrew-cask/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. 2. Tap (download a local clone of) the repository of core Homebrew casks: From e5a3f0e583e7c1f2e5484a435f43a0f818a39b28 Mon Sep 17 00:00:00 2001 From: Ryan Schumacher Date: Thu, 29 Aug 2024 15:54:32 -0500 Subject: [PATCH 7/9] Update docs/How-To-Open-a-Homebrew-Pull-Request.md Co-authored-by: Mike McQuaid --- docs/How-To-Open-a-Homebrew-Pull-Request.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 417704bd26..2dcb500cef 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -35,6 +35,7 @@ The type of change you want to make influences which of Homebrew's main reposito ### Formulae-related pull request Before creating a new formulae, please read [Acceptable Formulae](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Formulae.md). + 1. [Fork the Homebrew/homebrew-core repository on GitHub](https://github.com/Homebrew/homebrew-core/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. 2. Tap (download a local clone of) the repository of core Homebrew formulae: From b31a9b922e67e02e91da4882909884867c4b8810 Mon Sep 17 00:00:00 2001 From: Ryan Schumacher Date: Thu, 29 Aug 2024 15:55:12 -0500 Subject: [PATCH 8/9] Apply suggestions from code review Co-authored-by: Ruoyu Zhong --- docs/How-To-Open-a-Homebrew-Pull-Request.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 2dcb500cef..7c02128625 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -34,7 +34,8 @@ The type of change you want to make influences which of Homebrew's main reposito ### Formulae-related pull request -Before creating a new formulae, please read [Acceptable Formulae](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Formulae.md). +Before creating a new formulae, please read [Acceptable Formulae](https://docs.brew.sh/Acceptable-Formulae). + 1. [Fork the Homebrew/homebrew-core repository on GitHub](https://github.com/Homebrew/homebrew-core/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. @@ -60,7 +61,8 @@ Before creating a new formulae, please read [Acceptable Formulae](https://github ### Cask-related pull request -Before creating a new cask, please read [Acceptable Casks](https://github.com/Homebrew/brew/blob/master/docs/Acceptable-Casks.md). +Before creating a new cask, please read [Acceptable Casks](https://docs.brew.sh/Acceptable-Casks). + 1. [Fork the Homebrew/homebrew-cask repository on GitHub](https://github.com/Homebrew/homebrew-cask/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. 2. Tap (download a local clone of) the repository of core Homebrew casks: From ff6df8ee5649e6ca6e941f7ffd853c867499fb1a Mon Sep 17 00:00:00 2001 From: Ryan Schumacher Date: Thu, 29 Aug 2024 18:45:10 -0500 Subject: [PATCH 9/9] Update How-To-Open-a-Homebrew-Pull-Request.md Co-authored-by: Carlo Cabrera <30379873+carlocab@users.noreply.github.com> --- docs/How-To-Open-a-Homebrew-Pull-Request.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 7c02128625..71322d0176 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -36,7 +36,6 @@ The type of change you want to make influences which of Homebrew's main reposito Before creating a new formulae, please read [Acceptable Formulae](https://docs.brew.sh/Acceptable-Formulae). - 1. [Fork the Homebrew/homebrew-core repository on GitHub](https://github.com/Homebrew/homebrew-core/fork). * This creates a personal remote repository that you can push to. This is needed because only Homebrew maintainers have push access to the main repositories. 2. Tap (download a local clone of) the repository of core Homebrew formulae: