Skip to content

Commit 8d094b8

Browse files
authored
chore: Configure Amazon Q rules (#421)
1 parent 5362be0 commit 8d094b8

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

.amazonq/rules/rules.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
- Conform to the ZIP file specification at https://support.pkware.com/pkzip/appnote.
2+
- PR titles must conform to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and start
3+
with one of the types specified by the [Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type).
4+
The type prefix will usually be `fix:`, `feat:`, `perf:`, `docs:` or `chore(deps):`.
5+
- When adding a new compression or decompression method, add a feature flag for it.
6+
- Make sure that if new code has a dependency that's gated on a feature flag, then so is the new code.
7+
- Carefully consider the configurations of feature flags your change will affect, and test accordingly.
8+
- Optimize your code's performance for archives that contain many files *and* archives that contain large files.
9+
- Consider whether your change affects ZIP64 files. If so, test it on 4GiB files both with and without compression.
10+
Generate these files by copying repeatedly to or from the same buffer, so that the test doesn't occupy or allocate
11+
4GiB of memory.
12+
- Wait and see whether the tests for your PR pass in CI. Fix them if they fail.
13+
- Rebase your PR whenever it has a merge conflict. If you can't fix the rebase conflicts, rewrite it from scratch.
14+
- Always run `cargo fmt --all` and `cargo clippy --all-features --all-targets`.

0 commit comments

Comments
 (0)