From 5abcb19e6c0454906743a8d56c0534aafba30ae9 Mon Sep 17 00:00:00 2001 From: Hermet Park Date: Fri, 4 Jun 2021 17:43:04 +0900 Subject: [PATCH] Update CONTRIBUTING.md ++ self-test & verification --- CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80f08755..ea9465c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,12 +12,30 @@ Hermet Park (hermet) is the lead maintainer but there are designated sub-module capi: Michal Szczecinski (mihashco), Mira Grudzinska (mgrudzinska)

- +## Self Test & Verification +After updated ThorVG code, please verify your change doesn't break the library. We suggests a unit-tests using Catch2 frameworks. You can easily run the Unit Tests with build commands as the following:
+
+` +$meson . build -Dtests=true +` +
+` +$ninja -C build test +` +
+
+Please make it sure running all tests and no any Fail cases.
+
+Expected Fail: 0
+Fail: 0
+Unexpected Pass: 0
+Skipped: 0
+Timeout: 0
+
## Commit Message [Module][Feature]: [Title] [Description] -## - [Module] is a sub module majorly affected by your change. Most of times this indicates a sub folder name. This indicates whom need to review your patch as well. @@ -75,16 +93,13 @@ You can keep the file name, but don't please contain any prefix(tvg) nor suffix( @References: any links to the references such as screenshot images. @Issues: 49 -
- - ## Pull Request - - Once you submitted a pull request(PR), please make it sure below check list. - - Reviewers: Check Reviewers List - - Assignees: You - - Labels: Patch Purpose - - CODING STYLE CHECK: Must be perfect -

- -

+
+ +## Pull Request +Once you submitted a pull request(PR), please make it sure below check list. +- Reviewers: Check Reviewers List +- Assignees: You +- Labels: Patch Purpose +- CODING STYLE CHECK: Must be perfect +