lowRISC / lowRISC/dvsim

Use and enforce conventional commits

Open
#6 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
13
Forks
21
Avg merge
1d 11h
Merged PRs (30d)
8

Description

There are a number of tools that parse commit messages and require a consistent format which classifies commits.
An example of this is the [python-semantic-release](https://python-semantic-release.readthedocs.io/en/latest/) tool which automatically determines the next python package version based on the commit message content.

- [ ] In-tree documentation about the release process for maintainers & expected commit style for contributors
- [ ] CI enforcing the use of conventional-commits as per #4

Contributor guide

Open the contributing guide

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 issue #4 and the linked python-semantic-release documentation. Locate the repository's existing release-process documentation and CI configuration, then define the expected conventional-commit format. Done means maintainers have in-tree release guidance and CI enforces the agreed commit style.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.