CONTRIBUTING.md

   1 We always appreciate your contribution. ThorVG doesn't expect perfect patch contributions, instead we expect contributions if your patch makes thorvg better than before. This page guides the ThorVG contribution format.<br />
   2 <br />
   3 ## Reviewers
   4 Hermet Park (hermet) is the lead maintainer. Also there are designated maintainers you can request your pull-request for separate modules.
   5
   6 <b>common:</b> Junsu Choi (JSUYA) <br />
   7 <b>sw_engine:</b> Junsu Choi (JSUYA), Mira Grudzinska (mgrudzinska), Peter Vullings (projectitis) <br />
   8 <b>svg_loader:</b> Junsu Choi (JSUYA), Mira Grudzinska (mgrudzinska) <br />
   9 <b>tvg_saver:</b> Mira Grudzinska (mgrudzinska) <br />
  10 <b>svg2png:</b> Junsu Choi (JSUYA) <br />
  11 <b>capi:</b> Mira Grudzinska (mgrudzinska) <br />
  12 <br />
  13
  14 ## Self Test & Verification
  15 After updating ThorVG code, please verify your change doesn't break the library. We suggest unit-tests using the Catch2 framework. You can easily run it with build commands as the following: <br />
  16 <br/>
  17 `
  18 $meson . build -Dtests=true -Dloaders="all" -Dsavers="tvg" -Dbindings="capi" -Dtools="all" -Dlog=true
  19 `
  20 <br />
  21 `
  22 $ninja -C build test
  23 `
  24 <br/>
  25 <br/>
  26 Please make it sure running all tests and no any fail case.<br/>
  27 <br/>
  28 Expected Fail:      0<br/>
  29 Fail:               0<br/>
  30 Unexpected Pass:    0<br/>
  31 Skipped:            0<br/>
  32 Timeout:            0<br/>
  33 <br/>
  34 ## Commit Message
  35 [Module][Feature]: [Title]
  36
  37 [Description]
  38
  39 - [Module] is a sub module majorly affected by your change. Most of times this indicates a sub folder name.
  40 This indicates whom need to review your patch as well.
  41 If your change don't belonged to any sub modules, you can replace with proper name or skip it.
  42 The name must be written in all lower alphabet characters.
  43   - ex) build / doc / infra / common / sw_engine / gl_engine / svg_loader / examples / wasm / svg2png  ...
  44
  45 - [Feature] is what major function/feature you changed. Normally this indicates a representive file name.
  46 You can keep the file name, but don't please contain any prefix(tvg) nor suffix(Impl) here.
  47   - ex) Canvas / TaskScehduler / SvgLoader / SvgBuilder / SwRle / GlRenderer / ...
  48
  49 - [Title] is a brief description of your change. It must be described in one sentence.
  50   - ex) "Fixed a typo"
  51   - ex) "Fixed compile warnings"
  52   - ex) "Code refactoring"
  53   - ex) "Fixed a rendering bug that overlapped shapes inproper way."
  54
  55 - [Description] There is no any strict formats, but it must describe what you did in this patch as far as possible you can describe in detail.
  56
  57   If you fixed any bugs, it must contain below:
  58   - what type of bug
  59   - conditions to reproduce it
  60   - root cause
  61   - solution
  62
  63   Or if you add a new feature or function, it must contain below:
  64   - what sort of features
  65   - api full specification (if any api additions)
  66   - any necessity
  67   - condition / restriction
  68   - reference or sample
  69
  70   Lastly, please append any issue ticket numbers in this section if any.
  71
  72
  73 - Here is a overall commit message what we expect to review:
  74
  75   - common composite: newly added path clipping feature
  76
  77     We introduced new method Paint::composite() to support composite behaviors. </br>
  78     This allows paints to composite with other paints instances. </br>
  79     Composite behaviors depend on its composite method type. </br>
  80     Here we firstly introduced "ClipPath" method to support clipping by path unit of paint.</br>
  81
  82     tagetPaint->composite(srcPaint, CompositeMethod::ClipPath);</br>
  83
  84     Beaware if the source paint doesn't contain any path info, clipping won't be applied as you expected.
  85
  86     @API Additions:</br>
  87     enum CompositeMethod {None = 0, ClipPath}; </br>
  88     Result Paint::composite(std::unique_ptr<Paint> target, CompositeMethod method) const noexcept;</br>
  89
  90     @Examples: added ClipPath</br>
  91
  92     @References: any links to the references such as screenshot images.
  93
  94     @Issues: 49
  95 <br />
  96
  97 ## Pull Request
  98
  99 Once you submitted a pull request(PR), please make it sure below check list.
 100 -  Reviewers: Check Reviewers List
 101 -  Assignees: You
 102 -  Labels: Patch Purpose
 103 -  CODING STYLE CHECK: Must be perfect
 104 <p align="center"><img width="1000" height="1072" src="https://github.com/Samsung/thorvg/blob/master/res/contribution.png"></p>