HSF / HSF/phoenix

Commit conventions and releases

Open
#424 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
88
Forks
105
Avg merge
16h 15m
Merged PRs (30d)
34

Description

I think we need to rethink our commit conventions. Our release notes have duplicated commits in them. See https://github.com/HSF/phoenix/releases/tag/v2.7.0

One recommendation I have is to not use the conventions for ordinary commits but only for when we merge a pull request to master. We already have a workflow where each feature is merged through a pull request, so it should work.

CC: @EdwardMoyse

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 with the v2.7.0 release linked in the issue and review the existing commit and pull-request merge workflow. Determine where duplicated commits enter the release notes and agree on the intended convention; done means the convention is documented and subsequent release notes no longer duplicate commits.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github
Domain
release
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.