Skip to content

Commit Convention

babygoat edited this page May 27, 2020 · 2 revisions

The commits to go-api should fall into following categories.

api/[routes group]: includes the changes(fix, new feature) in each route group.

doc: includes the changes to README and api documents.

core: includes the changes to core functions but not related to the specific routes.

chore: include the maintenance tasks(e.g., build/ci/automation)

For router groups, go-api supports following categories.

  • auth(including both email login and oauth)
  • user(including bookmark)
  • news (including post, topic, index_page, search, author etc)
  • webpush
  • donation
  • mail
Clone this wiki locally