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