Skip to content
Snippets Groups Projects
Verified Commit 0782c59a authored by Lars Frost's avatar Lars Frost
Browse files

Improve Best Practices

parent 996c8f2f
No related branches found
No related tags found
No related merge requests found
#import "@preview/touying:0.5.3": * #import "@preview/touying:0.5.3": *
= Collaboration = Best Practices
== Wie sieht ein guter Commit aus? == Wie sieht ein guter Commit aus?
=== Vollständig === Vollständig
...@@ -9,36 +9,76 @@ Vor und nach dem Commit sollte alles außer dem beabsichtigten geänderten Verha ...@@ -9,36 +9,76 @@ Vor und nach dem Commit sollte alles außer dem beabsichtigten geänderten Verha
=== Atomic === Atomic
Wenn es sinnvoll sein kann den Commit teilweise zu reverten, ist er zu groß. Wenn es sinnvoll sein kann den Commit teilweise zu reverten, ist er zu groß.
== The Not Rocket Science Rule Of Software Engineering // == The Not Rocket Science Rule Of Software Engineering
"maintain a branch that always passes all the tests" // // https://graydon2.dreamwidth.org/1597.html
// Maintain a branch that always passes all the tests\
// - basierend auf Regel von Graydon Hoare
Implemented in: // Implemented in:
- #link("https://docs.gitlab.com/ee/ci/pipelines/merge_trains.html")[GitLab: Merge Trains] // - #link("https://docs.gitlab.com/ee/ci/pipelines/merge_trains.html")[GitLab: Merge Trains]
- #link("https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue")[GitHub: Merge Queues] // - #link("https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue")[GitHub: Merge Queues]
== Wie sieht eine gute Commit Message aus? So nicht. == Wie sieht eine gute Commit Message aus? So nicht.
#align(center, link("https://github.com/MontiCore/monticore/commits/dev/?after=f7fb15d399f3283af3e9c8a795bf3366768870d6+90", image("/images/BR.png", height: auto))) #align(center, link("https://github.com/MontiCore/monticore/commits/dev/?after=f7fb15d399f3283af3e9c8a795bf3366768870d6+90", image("/images/BR.png", height: auto)))
#let pad-spaces(n, width) = {
let s = str(n)
if s.len() < width {
return " " * (width - s.len()) + s
}
return s
}
#show raw.where(block: true): code => {
show raw.line: line => {
text(fill: gray)[#pad-spaces(line.number, 2)]
h(1em)
line.body
}
code
}
== Wie sieht eine gute Commit Message aus? Beispiel == Wie sieht eine gute Commit Message aus? Beispiel
// #link(
// "https://github.com/bevyengine/bevy/commit/0ac495f7f42ec91e2d215e5afa56d9c4a9c1741f",
// ```txt
// Remove accesskit re-export from bevy_a11y (#16257)
// # Objective
// - Fixes #16235
// ## Solution
// - Both Bevy and AccessKit export a `Node` struct, to reduce confusion
// Bevy will no longer re-export `AccessKit` from `bevy_a11y`
// ## Migration Guide
// - Users will need to add `accesskit = "0.17"` to the dependencies
// section of their `Cargo.toml` file and update their `accesskit` use
// statements to come directly from the external crate instead of
// `bevy_a11y`.
// - Make sure to keep the versions of `accesskit` aligned with the
// versions Bevy uses.
// ```
// )
#link( #link(
"https://github.com/bevyengine/bevy/commit/0ac495f7f42ec91e2d215e5afa56d9c4a9c1741f", "https://cbea.ms/git-commit",
```txt ```txt
Remove accesskit re-export from bevy_a11y (#16257) Summarize changes in around 50 characters or less
# Objective More detailed explanatory text, if necessary. Wrap it to about 72
- Fixes #16235 characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
## Solution blank line separating the summary from the body is critical (unless
- Both Bevy and AccessKit export a `Node` struct, to reduce confusion you omit the body entirely); various tools like `log`, `shortlog`
Bevy will no longer re-export `AccessKit` from `bevy_a11y` and `rebase` can get confused if you run the two together.
## Migration Guide Explain the problem that this commit is solving. Focus on why you
- Users will need to add `accesskit = "0.17"` to the dependencies are making this change as opposed to how (the code explains that).
section of their `Cargo.toml` file and update their `accesskit` use Are there side effects or other unintuitive consequences of this
statements to come directly from the external crate instead of change? Here's the place to explain them.
`bevy_a11y`.
- Make sure to keep the versions of `accesskit` aligned with the If you use an issue tracker, put references at the bottom:
versions Bevy uses. Fixes: #123
See also: #456, #789
``` ```
) )
...@@ -46,7 +86,7 @@ versions Bevy uses. ...@@ -46,7 +86,7 @@ versions Bevy uses.
#v(1fr) #v(1fr)
=== Was ich aus der Message lernen soll === Was ich aus der Message lernen soll
- Welche Verhaltensänderung wurde beabsichtig? - Welche Verhaltensänderung wurde beabsichtigt?
- Warum gibt es diese Änderung? - Warum gibt es diese Änderung?
- "If applied, this commit will ..." oder "After this commit, the program will ..." - "If applied, this commit will ..." oder "After this commit, the program will ..."
...@@ -64,6 +104,6 @@ versions Bevy uses. ...@@ -64,6 +104,6 @@ versions Bevy uses.
- Imperativ - Imperativ
- Großgeschrieben anfangen - Großgeschrieben anfangen
- Ohne Punkt am Ende - Ohne Punkt am Ende
- Titel $approx 50$ Zeichen, maximal $72$ - Titel $< 50$ Zeichen, maximal $72$
#v(1fr) #v(1fr)
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment