docs: various tweaks. #16290
Merged
docs: various tweaks. #16290
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rylan12
approved these changes
Dec 4, 2023
Bo98
approved these changes
Dec 4, 2023
reitermarkus
reviewed
Dec 4, 2023
razvanazamfirei
approved these changes
Dec 5, 2023
SMillerDev
reviewed
Dec 5, 2023
MikeMcQuaid
commented
Dec 5, 2023
carlocab
approved these changes
Dec 6, 2023
ZhongRuoyu
approved these changes
Dec 6, 2023
Adjust various maintainer and contributor-focused documents after recent maintainer conversations and generally anything I noticed was wrong or outdated as I went through these.
chenrui333
reviewed
Dec 7, 2023
Comment on lines
+47
to
+53
| ## 5. Slow Down | ||
|
|
||
| We're a volunteer-run open source project used by a lot of people. That can mean | ||
| that it feels like there's a lot of pressure to get a fix, package or project | ||
| completed ASAP. Try to not feel this pressure; slow down, focus on Homebrew | ||
| being enjoyable. If in doubt: over-communicate your decision making. A revert | ||
| can always be done now and a proper fix done tomorrow. |
chenrui333
reviewed
Dec 7, 2023
| @@ -147,11 +143,11 @@ Sometimes we have to edit a `Makefile` on-the-fly to use our prefix for the Pyth | |||
|
|
|||
| ## Libraries | |||
|
|
|||
| ### Python declarations for libraries | |||
| Remember: there are very limited cases for libraries (e.g. significant amounts of native code is compiled) so, if in doubt, do not package them. | |||
0xdevalias
reviewed
Dec 13, 2023
| In general, using GitHub's "Squash and Merge" button is the best way to merge a PR. This can be used when the PR modifies only one cask, regardless of the number of commits or whether the commit message format is correct. When merging using this method, the commit message can be modified if needed. Usually, version bump commit messages follow the form `Update CASK from OLD_VERSION to NEW_VERSION`. | ||
| In general, using GitHub's "Merge" button is the best way to merge a PR. This can be used when the PR modifies only one cask, regardless of the number of commits or whether the commit message format is correct. When merging using this method, the commit message can be modified if needed. Usually, version bump commit messages follow the form `Update CASK from OLD_VERSION to NEW_VERSION`. |
There was a problem hiding this comment.
I realise this PR is already merged, but I wanted to clarify whether this paragraph still remains true after changing from 'Squash and Merge' to 'Merge'; as the latter parts of it seem directly related to a squash merge, not a normal merge?
There was a problem hiding this comment.
Yeah the paragraph isn't quite correct here.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adjust various maintainer and contributor-focused documents after recent maintainer conversations and generally anything I noticed was wrong or outdated as I went through these.