EricFromCanada
d9ef454528
CI: add docs.yml
...
With fixes for Markdown syntax to allow tests to pass.
2022-11-26 10:28:12 -05:00
EricFromCanada
d615899ca9
Contributors docs: content & formatting updates
...
Update How-To-Open-a-Homebrew-Pull-Request.md
Update Acceptable-Formulae.md
Update Acceptable-Casks.md
Update License-Guidelines.md
Update Versions.md
Update Versions.md
Update Deprecating-Disabling-and-Removing-Formulae.md
Update Node-for-Formula-Authors.md
Update Python-for-Formula-Authors.md
Update Brew-Livecheck.md
Update Migrating-A-Formula-To-A-Tap.md
Update Rename-A-Formula.md
Update How-to-Create-and-Maintain-a-Tap.md
Update Brew-Test-Bot.md
Update Typechecking.md
2022-11-16 09:03:12 -05:00
Carlo Cabrera
47a55e2821
Tweak wording
2022-01-18 19:01:31 +08:00
Carlo Cabrera
121771f1a6
Apply suggestions from code review
...
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2022-01-18 18:57:14 +08:00
Carlo Cabrera
9c171ea7da
Update acceptable deprecation of formulae with dependents
2022-01-16 17:15:58 +08:00
Carlo Cabrera
6214ce3024
Update documentation on deprecating and disabling formulae
...
This is based on the discussion at Homebrew/homebrew-core#91368 .
A few reasons why we don't want to deprecate formulae that have
dependents:
1. This results in displaying warning messages to (at least some) users
that they can't do anything about.
2. `test-bot` does not test deprecated formulae, so we risk breaking
dependent formulae when one of its dependencies is not tested.
3. It is much harder to commit to a disable date for formulae with
dependents because we don't know when we'll be able to wean
dependents off of a deprecated formula.
I think it's important to have a disable date in mind when we deprecate
formulae. Otherwise, we might end up leaving formulae deprecated
indefinitely. This is bad because it teaches users to not take
deprecation warnings seriously.
2022-01-16 00:43:41 +08:00
Rylan Polster
5f887ca934
docs: clarify formula deprecation conditions
...
Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
2020-12-28 11:28:17 -05:00
Rylan Polster
5784e36ead
docs: improve clarity in deprecate/disable/removal docs
...
Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
Co-Authored-By: Michka Popoff <3406519+iMichka@users.noreply.github.com>
Co-Authored-By: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2020-12-28 10:31:14 -05:00
Rylan Polster
09132be32a
docs: use list for common disable reasons
...
Co-Authored-By: Adrian Ho <the.gromgit@gmail.com>
2020-12-27 13:49:25 -05:00
Rylan Polster
b125bd92cf
docs: incorporate changes from code review
...
Co-Authored-By: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2020-12-25 12:13:38 -05:00
Rylan Polster
5a1adeae06
docs: incorporate changes from code review
...
Co-Authored-By: Seeker <meaningseeking@protonmail.com>
Co-Authored-By: Sean Molenaar <smillerdev@me.com>
Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
Co-Authored-By: Michka Popoff <3406519+iMichka@users.noreply.github.com>
2020-12-25 11:00:58 -05:00
Rylan Polster
361eb27110
docs: fix some copy-and-paste mistakes
...
Co-Authored-By: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2020-12-25 00:09:57 -05:00
Rylan Polster
6739064a5e
docs: clarity improvements to deprecate/disable/remove docs
2020-12-25 00:07:13 -05:00
Rylan Polster
e0badc90e0
docs: add deprecate/disable/removal documentation
2020-12-24 22:42:43 -05:00
