Merge pull request #16585 from issyl0/rm-ancient-flowchart
Delete ancient 'managing PRs' flowchart
This commit is contained in:
commit
dbb10da4b0
@ -16,11 +16,6 @@ trim_trailing_whitespace = true
|
||||
# trailing whitespace is crucial for patches
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
[**.drawio.svg]
|
||||
indent_size = unset
|
||||
indent_style = unset
|
||||
insert_final_newline = false
|
||||
|
||||
[**.md]
|
||||
trim_trailing_whitespace = true
|
||||
x-soft-wrap-text = true
|
||||
|
@ -1,45 +0,0 @@
|
||||
# Diagram Guidelines
|
||||
|
||||
## Preferred file format
|
||||
|
||||
For complex diagrams, use the `.drawio.svg` format.
|
||||
|
||||
Files with the `.drawio.svg` extension are SVG files with embedded [draw.io](https://www.diagrams.net/) source code. Using that format lends itself to a developer-friendly workflow: it is valid SVG, plays well with `git diff` and can be edited in lock-step using various online and offline flavours of draw.io. If you use VS Code, you can use an [extension](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) for draw.io integration.
|
||||
|
||||
Files in the `.drawio.svg` format can be processed offline.
|
||||
|
||||
## Embedding a diagram into Markdown
|
||||
|
||||
To embed a `.drawio.svg` file into Markdown, use the same syntax as for any image. Example: ``
|
||||
|
||||
Mind that GitHub doesn’t allow styling in Markdown documents. Where styling is allowed (e.g. in the exported brew.sh version of the documentation), always set a background colour of `white` for the diagram. That’s the colour draw.io assumes, and keeps the diagram easy to read in dark mode without further customization. You can use the CSS selector `img[src$=".drawio.svg"]` for styling.
|
||||
|
||||
## Example
|
||||
|
||||
Example for an SVG image embedded into Markdown:
|
||||
|
||||
```md
|
||||

|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||

|
||||
|
||||
Example for styling (where allowed):
|
||||
|
||||
```css
|
||||
img[src$=".drawio.svg"] {
|
||||
background-color: white;
|
||||
margin-bottom: 20px;
|
||||
padding: 5%;
|
||||
width: 90%;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
img[src$=".drawio.svg"] {
|
||||
filter: invert(85%);
|
||||
-webkit-filter: invert(85%);
|
||||
}
|
||||
}
|
||||
```
|
@ -25,7 +25,7 @@ For most PRs that make formula modifications, you can simply approve the PR and
|
||||
|
||||
Certain PRs may not be merged automatically by [@BrewTestBot](https://github.com/BrewTestBot), even after they've been approved. This includes PRs with the `new formula`, `automerge-skip`, and `linux-only` labels. To trigger a merge for these PRs, run `brew pr-publish`.
|
||||
|
||||
PRs modifying formulae that don't need bottles or making changes that don't require new bottles to be pulled should use GitHub's squash & merge or rebase & merge workflows. See the [table below](#how-to-merge-without-bottles) for more details.
|
||||
PRs modifying formulae that don't need bottles or making changes that don't require new bottles to be pulled should use GitHub's squash & merge or rebase & merge workflows.
|
||||
|
||||
Otherwise, you should use `brew pr-pull` (or `rebase`/`cherry-pick` contributions).
|
||||
|
||||
@ -35,10 +35,6 @@ Cherry-picking changes the date of the commit, which kind of sucks.
|
||||
|
||||
Don’t `merge` unclean branches. So if someone is still learning `git` and their branch is filled with nonsensical merges, then `rebase` and squash the commits. Our main branch history should be useful to other people, not confusing.
|
||||
|
||||
Here’s a flowchart for managing a PR which is ready to merge:
|
||||
|
||||

|
||||
|
||||
Only one maintainer is necessary to approve and merge the addition of a new or updated formula which passes CI. However, if the formula addition or update proves controversial the maintainer who adds it will be expected to answer requests and fix problems that arise with it in future.
|
||||
|
||||
### How to merge without bottles
|
||||
|
@ -51,7 +51,6 @@
|
||||
- [Building Against Non-Homebrew Dependencies](Building-Against-Non-Homebrew-Dependencies.md)
|
||||
- [How to Create and Maintain a Tap](How-to-Create-and-Maintain-a-Tap.md)
|
||||
- [Brew Test Bot](Brew-Test-Bot.md)
|
||||
- [Diagram Guidelines](Diagram-Guidelines.md)
|
||||
- [Prose Style Guidelines](Prose-Style-Guidelines.md)
|
||||
- [Type Checking with Sorbet](Typechecking.md)
|
||||
- [Reproducible Builds](Reproducible-Builds.md)
|
||||
|
File diff suppressed because one or more lines are too long
Before Width: | Height: | Size: 44 KiB |
Loading…
x
Reference in New Issue
Block a user