PyPSA / PyPSA/pypsa-app

Conventional commits

Open
#104 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

needs discussion
Dominant language
Python
Stars
25
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Should we enforce conventional commits for every squashed PR's commit message? Commits on a branch which are going to be squashed can look like preferred. But on the master branch it keeps history consistent and lets us auto generate release notes much better. Strict semver versioning probably doesn't matter much for an app like this, but I think it's in general a good convention

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how pull requests are squashed and how releases or release notes are generated in this repository. Define whether conventional commits should be enforced and determine what checks or workflow changes would make squashed commits comply, then verify the resulting history and release-note generation.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github
Domain
ci-cd, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.