Skip to content

doc: Release / contribution guide updates#195

Open
hcallahan-lowrisc wants to merge 3 commits into
lowRISC:masterfrom
hcallahan-lowrisc:release_contrib_updates
Open

doc: Release / contribution guide updates#195
hcallahan-lowrisc wants to merge 3 commits into
lowRISC:masterfrom
hcallahan-lowrisc:release_contrib_updates

Conversation

@hcallahan-lowrisc
Copy link
Copy Markdown
Contributor

Flesh out the contribution guidelines and docs to better reflect the use of conventional commits / semantic-release to automate project releases, and the expectations upon contributors to follow these guidelines to categorize their contributions appropriately.

  • Add a releasing.md document explaining the conventional commits style and automated release processes.
  • Updating the CONTRIBUTING.md file to also describe the requirement for following the commit style guides for automated release management. Also strip out a bit of opentitan-specific guidance that no longer applies within this project.
  • Add a pull request template message, which summarizes the commit message guidelines, and points the user towards the releasing documentation for a fuller reference. Finish off with a checklist for the contributor to confirm that they have met these requirements with their changes.

Signed-off-by: Harry Callahan <hcallahan@lowrisc.org>
- Summarize important contribution guidelines in checklist
- Describe the commit message format for automatic semver releases

Signed-off-by: Harry Callahan <hcallahan@lowrisc.org>
- Remove obsolete style guidance that was more opentitan specific
- Conventional Commit / SemVer impact guidelines for commit message
- Minor style and prose cleanups and simplifications

Signed-off-by: Harry Callahan <hcallahan@lowrisc.org>
@hcallahan-lowrisc hcallahan-lowrisc force-pushed the release_contrib_updates branch from b9a99ee to e246568 Compare May 14, 2026 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant