Skip to content

Latest commit

History

History
51 lines (37 loc) 路 1.89 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) 路 1.89 KB

CONTRIBUTING

What is the workflow?

  1. Create and describe your proposal/bug in an issue.
  2. Create a new branch and merge request with the pattern 1-my-feature.
  3. Commit your code to the commit convention.

Convention of Commits and Semantic Version

Commit Structure

type(escope): short description

What does the modification do?
why was it modified?

#issue
  • fix Fix a bug
  • add Add a new feature
  • remove Remove a peace of code
  • deprecate compatibility break
  • update Update any thing. e.g. feature, piece, refact

Semantic Version

  • deprecate -> Major
  • add -> Minor
  • fix -> Patch

References