search

ispyb / py-ispyb

ISPyB backend server based on FastAPI
GNU Lesser General Public License v3.0
12 stars 14 forks source link

Commit message format + python-semantic-release #185

Open antolinos opened 2 years ago

antolinos commented 2 years ago

I wonder if it could be convenient to standardize the commit message format. I saw some python projects using the Angular commit message format .

It is rather simple to use (and understand):

# Commit to edit a CI job
ci: edit linting job #issue-number

# Commit for a bug fix
fix: fix bug found with count endpoints #issue-number

# Commit for a new feature
feat: add endpoints for search API #issue-number

# Commit which introduces a breaking change for users
<commit-type>: change format of `config.json`, the previous version is no longer supported #issue-number

BREAKING CHANGE: this feature means X functionality has been removed

Then, we can also use semantinc-release to automatize the package release workflow, I found interesting how they describe it:

This removes the immediate connection between human emotions and version numbers, strictly following the Semantic Versioning specification and communicating the impact of changes to consumers.

The python implementation of semantic-release can be found on python-semantic-release

mgaonach commented 2 years ago

July 6th 2022 framework meeting:

It was decided to adopt this commit format message in the project. We need to: • Update the guidelines accordingly • Make sure every collaborator is informed • See if it could be enforced automatically – through github action and/or git hooks