Skip to content

AchoBeta/achobeta-official-backend

Repository files navigation

AchoBeta-official-backend

achobeta team website backend service

简体中文

before develop

  1. execute command in the root directory
git config core.hooksPath .githooks 
chmod -R -x .githooks 
  • The purpose of the above command is to trigger a hook when submitting a commit to confirm whether the commit message is correct.
  1. Read the development specifications below

branch naming convention

we must confirm:

  1. Branch naming should include a name to identify the person responsible.

  2. Branch naming must clearly express what problem the branch is working on.

so branch naming must be standardizedSo branch naming must be standardized.

<type>-<name>-<description>

for example:

  • if it is a branch to develop new functions, the naming convention is as follows
feature-<name>-<feature description>
e.g.: feature-jett-dev_log_system
  • if is fix bugs:
bugfix-<name>-<bug name>
e.g.: bugfix-jett-login_error

and other types: hotfixrelease...

commit message format

commit message should be written as clearly as possible, and each commit should only do one thing.

<type>(<scope>): <subject>

e.g.: feat: add new api
or: feat(common): add new api

type

feat: feature

fix: fix bug

docs: documentation

test: add test function

style: format (changes that do not affect code operation).

refactor: Refactoring (that is, code changes that are not new features or bug fixes).

subject

No period or punctuation at the end

e.g.

feat: add new feature
fix: fix a bug

Releases

No releases published

Packages

No packages published