Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update style guide #1339

Merged
merged 4 commits into from
Jun 24, 2024
Merged

Update style guide #1339

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
48cd2a2
Be more strict with feature branch size
maltekliemann Jun 7, 2024
4866411
Clarify our workflow
maltekliemann Jun 7, 2024
2d93562
Fix formatting
maltekliemann Jun 7, 2024
e13110d
Merge branch 'develop-v0.5.4' into mkl-style-guide
mergify[bot] Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/STYLE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,11 @@ duplicating documentation.

- Merges require one review. Additional reviews may be requested.
- Every merge into a feature branch requires a review.
- Feature branches are merged into `develop`, which is merged into
`release-vX.Y.Z` branches when we're publishing a release.
- Aim for at most 500 LOC added per PR. Only exceed 1,000 LOC lines added in a
PR in exceptional circumstances. Plan ahead and break a large PR into smaller
PRs targeting a feature branch. Feature branches are exempt from this rule.
- Reviews take priority over most other tasks.
PRs.
- Reviewing a PR should not take longer than two business days. Aim for shorter
PRs if the changes are complex.
- A PR should not be in flight (going from first `s:ready-for-review` to
Expand All @@ -163,7 +164,7 @@ duplicating documentation.
// In code logic
zeitgeist_macros::unreachable_non_terminating!(condition, log_target, message)
```

```rust
// In test
#[test]
Expand Down
Loading