mirrors/anki

mirror of https://github.com/ankitects/anki.git synced 2026-09-10 03:59:09 -04:00

Go to file

Fernando Lins 392fdecbb3 docs: add unit testing guidelines (#5522 )

## Linked issue

Closes #5521

## Summary / motivation

Adds an Anki-focused unit testing guide for maintainers, contributors,
and coding assistants.

The guide:

- Defines principles for focused, deterministic, and maintainable tests.
- Covers happy paths, error paths, boundaries, regressions, and
test-first development.
- Provides guidance for Python, Python/Qt, Rust, and
Svelte/TypeScript/JavaScript.
- Clarifies the appropriate scope for UI tests and discourages testing
styling or volatile presentation details.
- Links the guide from the shared `CLAUDE.md`/`AGENTS.md` instructions.

2026-09-09 17:03:26 -03:00

Use rust-lld on Windows (#4650 )

2026-07-06 23:16:36 +08:00

Drop workspace-hack in favor of workspace deps

2023-06-23 17:41:31 +10:00

Make URL schemes dialog more ergonomic (#4002 )

2025-05-15 16:17:33 +10:00

fix(ci): correct paginate mapFn in prune-coverage-cache workflow (#5504 )

2026-09-01 19:28:45 +03:00

Update PyCharm docs (#4389 )

2025-10-27 19:27:50 +07:00

chore: Configure mypy extension for VS Code (#5317 )

2026-08-14 22:02:00 +03:00

chore: Move .github/scripts/*.py to tools/ (#5375 )

2026-08-21 18:01:42 +03:00

bump fsrs to 6.6.2 (#5494 )

2026-09-02 12:41:04 +03:00

docs: add unit testing guidelines (#5522 )

2026-09-09 17:03:26 -03:00

docs: add unit testing guidelines (#5522 )

2026-09-09 17:03:26 -03:00

fix: rename markdown deck description label (#5489 )

2026-09-04 16:02:58 +03:00

feat: improved error message for CSV import (#5484 )

2026-09-01 15:43:18 +03:00

fix: Add compatibility shims for AnkiPackageImporter/AnkiPackageExporter (#5547 )

2026-09-08 21:30:34 +03:00

Build and publish dev docs (#4579 )

2026-03-31 08:26:59 -04:00

feat: Set up fault handler (#5546 )

2026-09-08 21:30:09 +03:00

test: cover the decks service layer (#5514 )

2026-09-08 17:10:11 -03:00

fix(ci): prevent silent skip of PR coverage-regression check on evicted baseline (#5480 )

2026-08-30 21:07:18 -03:00

fix: preserve FSRS unlock timeout across mounts (#5536 )

2026-09-08 21:42:14 +01:00

.complexipy.toml

chore: Integrate Complexipy for complexity analysis (#4942 )

2026-06-04 19:29:37 +03:00

.deny.toml

chore: Fix advisory RUSTSEC-2026-0204 (#5129 )

2026-07-09 13:04:37 +03:00

.dockerignore

Add distroless Dockerfile and implement internal health check (#3366 )

2024-08-29 17:05:33 +07:00

.dprint.json

docs: Replace docs/ with symlinks (#5031 )

2026-08-04 22:01:31 +03:00

.eslintrc.cjs

Shift editor control to TypeScript (#4029 )

2026-07-03 21:56:43 +03:00

.gitattributes

try again to improve GitHub's language stats

2021-01-20 13:20:45 +10:00

.gitignore

chore: Integrate Complexipy for complexity analysis (#4942 )

2026-06-04 19:29:37 +03:00

.gitmodules

Briefcase Installer (#4629 )

2026-05-05 17:29:18 -04:00

.mypy.ini

chore: set strict_optional = True for editor_legacy.py (#5367 )

2026-08-19 15:55:52 +03:00

.pre-commit-config.yaml

chore: Run complexipy-diff as part of ninja check (#4987 )

2026-06-10 21:04:15 +03:00

.prettierrc

Switch back to Prettier for Svelte formatting

2025-01-13 15:53:55 +11:00

.python-version

feat: Distribute compiled sources in Briefcase bundle (#4856 )

2026-05-18 17:47:03 +03:00

.readthedocs.yaml

Build and publish dev docs (#4579 )

2026-03-31 08:26:59 -04:00

.ruff.toml

Switch to Ruff (#4119 )

2025-06-29 14:38:35 +07:00

.rustfmt-empty.toml

Move away from Bazel (#2202 )

2022-11-27 15:24:20 +10:00

.rustfmt.toml

Move ascii_percent_encoding into a separate repo

2023-04-12 08:45:23 +10:00

.version

26.08.1 (#5281 )

2026-08-06 19:16:54 +03:00

.yarnrc.yml

chore: add release-age controls for uv and Yarn dependencies (#4761 )

2026-04-30 13:38:42 -03:00

AGENTS.md

chore: Updates just recipes and add AGENTS.md (#4943 )

2026-06-03 12:02:18 -03:00

Cargo.lock

bump fsrs to 6.6.2 (#5494 )

2026-09-02 12:41:04 +03:00

Cargo.toml

bump fsrs to 6.6.2 (#5494 )

2026-09-02 12:41:04 +03:00

check

build: portability fixes for FreeBSD (#5300 )

2026-08-11 13:13:56 +03:00

CLAUDE.md

docs: add unit testing guidelines (#5522 )

2026-09-09 17:03:26 -03:00

CONTRIBUTORS

fix: preserve FSRS unlock timeout across mounts (#5536 )

2026-09-08 21:42:14 +01:00

justfile

chore: Move complexipy out of Ninja checks (#5082 )

2026-07-01 17:48:06 +03:00

LICENSE

Clarify docs license (#5292 )

2026-08-07 15:57:00 +03:00

ninja

CI: Apply a consistent Cargo profile (#5133 )

2026-08-12 10:17:29 +03:00

package.json

chore: Update browser compatibility database (#5520 )

2026-09-08 19:10:00 +03:00

playwright.config.ts

fix(ci): fix flaky e2e editor tests caused by premature webServer readiness (#5116 )

2026-07-07 10:20:43 +03:00

pyproject.toml

feat: Update to Briefcase 0.4.5 (#5545 )

2026-09-08 19:20:44 +03:00

README.md

PoC: evaluate SonarCloud as a code quality and coverage tool (#4996 )

2026-08-26 15:48:45 -03:00

release.just

chore: Move .github/scripts/*.py to tools/ (#5375 )

2026-08-21 18:01:42 +03:00

run

build: portability fixes for FreeBSD (#5300 )

2026-08-11 13:13:56 +03:00

run.bat

fix: Update allowed origins for recent Chromium (#5080 )

2026-06-30 19:29:03 +03:00

rust-toolchain.toml

chore: bump rust toolchain to 1.97.1 (#5316 )

2026-08-11 14:06:50 +03:00

SECURITY.md

Update security.md. (#4790 )

2026-05-11 13:04:24 -04:00

sonar-project.properties

PoC: evaluate SonarCloud as a code quality and coverage tool (#4996 )

2026-08-26 15:48:45 -03:00

tsconfig.json

Shift editor control to TypeScript (#4029 )

2026-07-03 21:56:43 +03:00

uv.lock

feat: Update to Briefcase 0.4.5 (#5545 )

2026-09-08 19:20:44 +03:00

yarn

build: portability fixes for FreeBSD (#5300 )

2026-08-11 13:13:56 +03:00

yarn.bat

Switch to SvelteKit (#3077 )

2024-03-31 09:16:31 +01:00

yarn.lock

chore: Update browser compatibility database (#5520 )

2026-09-08 19:10:00 +03:00

README.md

Anki

This repo contains the source code for the computer version of Anki.

About

Anki is a spaced repetition program. Please see the website to learn more.

Getting Started

Contributing

Want to contribute to Anki? Check out the Contribution Guidelines.

For more information on building and developing, please see Development.

Contributors

The following people have contributed to Anki: CONTRIBUTORS

Anki Betas

If you'd like to try development builds of Anki but don't feel comfortable building the code, please see Anki betas.

License

Anki's license: LICENSE

Languages

Rust 39.8%

Python 24.3%

MDX 13.9%

TypeScript 10.4%

Svelte 9.8%

Other 1.4%