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