diff --git a/CHANGELOG.md b/CHANGELOG.md index d44c65f56..995027225 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). * Added utility functions `isStandardContextType(contextType: string)`, `isStandardIntent(intent: string)`,`getPossibleContextsForIntent(intent: StandardIntent)`. ([#1139](https://github.com/finos/FDC3/pull/1139)) * Added support for event listening outside of intent or context listnener. Added new function `addEventListener`, type `EventHandler`, enum `FDC3EventType` and interfaces `FDC3Event` and `FDC3ChannelChangedEvent`. ([#1207](https://github.com/finos/FDC3/pull/1207)) * Added new `CreateOrUpdateProfile` intent. ([#1359](https://github.com/finos/FDC3/pull/1359)) -* Added separate `fdc3-commonjs` module for compatibility with older projects that use CommonJS. ([#1452](https://github.com/finos/FDC3/pull/1452)) +* Added separate `fdc3-commonjs` module for compatibility with older projects that use CommonJS. ([#1452](https://github.com/finos/FDC3/pull/1452)) +* Added testing policy to [Contributing](CONTRIBUTING) page to address ([810](https://github.com/finos/FDC3/issues/810)) ### Changed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 623c7fb99..cd8c86a3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,6 +80,30 @@ The Working Group uses pull requests to track changes. To submit a change to the To contribute a patch for a New Intent, see the [Submit New Intent](docs/guides/submit-new-intent) guide. +**3.6. Test Policy** + +- The FDC3 project takes very seriously code quality, especially with respect to production-grade sub-modules. This includes: + +|Module | Test Policy | +|---|---| +|`packages/fdc3-agent-proxy` | Contributions must improve or maintain coverage at the current level | +|`packages/fdc3-get-agent` |Contributions must improve or maintain coverage at the current level +|`packages/fdc3-commonjs` | Code should not be added here | +|`packages/fdc3-context` | Must contain only JSON Schemas and source code generated from them | +|`packages/fdc3-schema` | Must contain only JSON Schemas and source code generated from them | +|`packages/fdc3-context` | Must contain only JSON Schemas and source code generated from them | +|`packages/fdc3-standard` | Contributions must improve or maintain coverage at the current level | +|`toolbox/fdc3-for-web/fdc3-web-impl` | Contributions must improve or maintain coverage at the current level | + +Please note that the FDC3 project uses the following test policy: + + * Code should have tests (coverage is reported in the PR comments) + * All tests must pass. (checked automatically by the PR comments) + * All tests must be meaningful. + * All tests must be kept up-to-date. + * All tests must be run locally before submitting a PR. + * Finally, the `toolbox/fdc3-for-web/demo` project is expected to pass the FDC3 conformance framework prior to new FDC3 releases (not currently automated). + ## 4. Pull Request Workflow. The next section contains more information on the workflow followed for Pull Requests.