Skip to content

Commit 04a2f9c

Browse files
committed
docs: state the bug-fixes-only scope explicitly
Maintenance mode now means a concrete policy rather than a tone: correctness, panics and security are in scope; new tables, new API and performance work are not, and feature requests are closed. Says so in both places a contributor looks before opening something, and spells out the in/out lists in CONTRIBUTING so the boundary is checkable rather than a judgement call.
1 parent 425014c commit 04a2f9c

2 files changed

Lines changed: 27 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,28 @@
44
TrueType, OpenType and AAT fonts. It sits underneath text rendering and it parses untrusted
55
input, so contributions are held to that standard.
66

7+
## Scope
8+
9+
**The crate is in maintenance mode: bug fixes only.**
10+
11+
In scope, and welcome:
12+
13+
- Incorrect parsing, wrong values, glyphs that fail to outline
14+
- Panics, aborts and unbounded work on malformed input
15+
- Fixes to existing table support
16+
17+
Out of scope, and will be closed:
18+
19+
- New table support and new public API
20+
- Performance work
21+
- Refactors that change the API surface
22+
23+
If you need broader coverage, [fontations](https://github.com/googlefonts/fontations) is
24+
actively developed and is what we recommend for new projects.
25+
26+
A bug report does not need to be phrased as a fix — if a font renders wrong, say so and we
27+
will work out whether the cause is in scope.
28+
729
## Repository layout
830

931
The repository root is **not** a Cargo workspace. It holds four independent crates:

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@
66
[![Rust 1.88+](https://img.shields.io/badge/rust-1.88+-orange.svg)](https://www.rust-lang.org)
77
![Unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-brightgreen.svg)
88

9-
> **Maintenance mode.** This crate is maintained for correctness and security, not for new
10-
> features. Bug reports and fixes are welcome and will be reviewed, but the table coverage is
11-
> unlikely to grow much further.
9+
> **This crate is in maintenance mode. Bug fixes only — no new features.**
10+
>
11+
> Bug reports and fixes are welcome and will be reviewed promptly. Correctness, panics and
12+
> security issues are in scope. New table support, new API surface and performance work are
13+
> not, and feature requests will be closed.
1214
>
1315
> **For new projects, we recommend [fontations](https://github.com/googlefonts/fontations)**
1416
> (`read-fonts` and `skrifa`), which is actively developed by Google Fonts, has broader table

0 commit comments

Comments
 (0)