eeyorelee/microservices-framework

A flask-based microservice framework. (一个基于flask的微服务框架)

Hi there 👋

microservices-framework's Issues

commit message standard

The repo adopts a standard similar to that of the Angular. The following are the details.

Commit message consists of three parts.

Header

Body

Footer

Header

Header takes this format. type(scope): subject

type

type is used to describe the type of commit and has the following scopes.

• feat: Feature
• fix: Fix bug
• docs: Documentation
• style: Formatting but do not affect code execution
• refactor: Refactor code without new featrue
• perf: Optimize performance
• test: Add or modify tests
• build: Changes affecting the build system or external dependencies
• ci: Changes to CI configuration files and scripts
• revert: Revert a commit

scope

scope is used to describe the scope of the commit's impact. If the scope of the change is too large to be described inconveniently, replace it with *.

subject

subject is a short description of the purpose of commit, which mainly introduces the main content of this code change.

Body

The Body part is a detailed description of this commit. Don't forget to leave a blank line between Body and Header ! If the subject in the Header has already described the content of this code change, the Body part can be empty.

Footer

If the commit is associated with a commit or issue, add the relevant commit Id or issue Id. It can be empty. As the same, Don't forget to leave a blank line between Footer and Body !