CONTRIBUTING.md

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