57618f746a
* Automatically label Wasmtime `Config` object changes * Add the "Label Messager" github action This allows us to have custom messages left in comments on issues and pull requests when they get labeled with a specific label. * Add a message for `wasmtime:config`-labeled pull requests * CI: Consolidate issue/PR triage workflows
1.7 KiB
It looks like you are changing Wasmtime's configuration options. Make sure to complete this check list:
-
If you added a new
Configmethod, you wrote extensive documentation for it.Our documentation should be of the following form:
Short, simple summary sentence. More details. These details can be multiple paragraphs. There should be information about not just the method, but its parameters and results as well. Is this method fallible? If so, when can it return an error? Can this method panic? If so, when does it panic? # Example Optional example here. -
If you added a new
Configmethod, or modified an existing one, you ensured that this configuration is exercised by the fuzz targets.For example, if you expose a new strategy for allocating the next instance slot inside the pooling allocator, you should ensure that at least one of our fuzz targets exercises that new strategy.
Often, all that is required of you is to ensure that there is a knob for this configuration option in
wasmtime_fuzzing::Config(or one of its nestedstructs).Rarely, this may require authoring a new fuzz target to specifically test this configuration. See our docs on fuzzing for more details.
-
If you are enabling a configuration option by default, make sure that it has been fuzzed for at least two weeks before turning it on by default.