Skip to content

Commit b5b3617

Browse files
authored
Update CONTRIBUTING.md
Only minor changes, release cadence is 4 weeks now.
1 parent 610fce4 commit b5b3617

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
Thank you for considering to contribute to rust-skia.
44

5-
We welcome all contributions, but most likely, a large part of your contribution will be Rust code.
5+
We welcome all contributions. Most likely, a large part of your contribution will be Rust code.
66

7-
To contribute Rust code, format the code with `cargo fmt` and be sure that there are no warnings with `cargo clippy`. Don't try too hard follow Clippy suggestions. If a warning does not make sense, add a comment that explains why, and mark the code with a `#[allow(clippy::*)]` attribute.
7+
To contribute Rust code, format the code with `cargo fmt` and be sure that there are no warnings with `cargo clippy`. Don't try too hard follow Clippy suggestions. If a warning does not make sense, add a comment that explains why and mark the code with a `#[allow(clippy::*)]` attribute.
88

99
If possible, add a small test case for you changes.
1010

11-
Your PR will be built for and tested on a number of targets on the CI before it can be merged. If that fails, we are probably able to help out.
11+
Your PR will be built for and tested on a number of targets on the CI before it can be merged. If that fails, we will do our best to help out.
1212

1313
If you'd like the changes in your PR to be released to [crates.io](https://crates.io/) timely, please say so, because we prefer to align crate releases with major [updates to Chrome stable](https://chromestatus.com/roadmap).
1414

@@ -23,21 +23,20 @@ We did our best to cover most of the Skia API, but you'll find a lot of blind sp
2323
- GPU API support is incomplete, specifically functions that use callbacks.
2424
- Supporting [Skottie](https://skia.org/user/modules/skottie) would be a nice addition.
2525

26-
For larger contributions, make yourself familiar with the [various wrapper types](https://github.com/rust-skia/rust-skia/wiki) of skia-safe and consider to file an issue beforehand to give us a heads up and to receive additional directions.
26+
For larger contributions, familiarize yourself with the [various wrapper types](https://github.com/rust-skia/rust-skia/wiki) and consider filing an issue beforehand to give us a heads up and to receive additional directions.
2727

2828
## Contributing Examples
2929

30-
Examples should be added to `/skia-safe/examples` or directly to the `/skia-org` executable which provides a minimal infrastructure to render to PNG , PDF, SVG files with the CPU or GPU.
30+
Examples should be added to `/skia-safe/examples` or directly to the `/skia-org` executable which provides a minimal infrastructure to render to PNG, PDF, and SVG files using the CPU or the GPU.
3131

3232
## Updating Skia
3333

34-
Since the beginning of this project, the maintainer team is updating rust-skia to match the Skia API version in the latest stable Chrome release. A new Chrome release [is scheduled](https://chromium.googlesource.com/chromium/src/+/master/docs/process/release_cycle.md) about every 6 weeks and most changes for the upcoming version are already settled when the current release is out, so there is enough time to update rust-skia. For most new Skia releases, the changes are trivial and can be integrated without breaking backwards compatibility on the Rust side.
34+
Since the beginning of this project, the maintainer team is updating rust-skia to match the Skia API version in the latest stable Chrome release. A new Chrome release [is scheduled](https://chromium.googlesource.com/chromium/src/+/master/docs/process/release_cycle.md) about every 4 weeks and most changes for the upcoming version are already settled when the current release is out, so there is enough time to update rust-skia. For most new Skia releases, the changes are trivial and are integrated without breaking backwards compatibility on the Rust side.
3535

3636
Even though this puts some pressure on dependent projects, we'd try to keep rust-skia updated, because falling behind Chrome's and Flutter's development to keep Skia _modern_ is not an option.
37-
38-
But keeping up might not always be possible. So if you use rust-skia, you might be interested to take a look at the [template used](https://github.com/rust-skia/rust-skia/wiki/Template:-Skia-Milestone-Update-PR) to update to the latest Skia version and perhaps even try to help us out from time to time.
37+
time.
3938

4039
## Licensing
4140

42-
Please ensure that the material you contribute is compatible with the MIT license.
41+
Please ensure that the code you contribute is compatible with the MIT license.
4342

0 commit comments

Comments
 (0)