Skip to content
This repository has been archived by the owner on Mar 8, 2021. It is now read-only.

Contributing to the Evolution Core

Deesen edited this page Jun 11, 2017 · 4 revisions

If you want to contribute code, it is recommended to create a separate branch of last commit of the original develop branch for it. This can extensively reduce the number of additional merge-commits into your PR.

And to be able to follow-up changes better for new releases, we want to promote the usage of clean descriptions for every commit:

[type of commit] #issue-no description

These are valid description-examples

  • [F] added missing icon
  • [F] #1234
  • [F] #1234 added missing event to TreeAction()

Types of commits

  • [F]: Fix
  • [R]: Refactor
  • [I]: Improvement
  • [S]: Security
  • [D]: Remove
  • [C]: Code clean-up
  • [O]: Other / miscellaneous

Fix [F]
Commits related to fixing bugs, issues and any kind of problems.

Refactor [R]
Code has been rewritten from scratch, not just small fixes, while providing same (and/or more) functionality.

Improvement [I]
New features, functions, addons ..

Security [S]
Any commits related to close security-holes or improving security and hardening Evo.

Remove [D]
If files are removed from core, the commit should be labeled with D like "Delete".

Code clean-up [C]
Commits related to cleaning up code (PHP, HTML, CSS, JS etc), removing PHP-notices and such.

Other / miscellaneous [O]
Commits not fitting in above categories.