docs: Add Conventional Commits specification #75
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @JackPlowman and the rest of your teammates on |
Merged
JackPlowman
changed the title
|
Merge activity
|
JackPlowman
deleted the
09-29-add_conventional_commits_documentation
branch
This was referenced Sep 29, 2024
JackPlowman
added a commit
that referenced
this pull request
Sep 29, 2024
🤖 I have created a release *beep* *boop* --- ## 1.0.0 (2024-09-29) ### 🚀 Features * Migrate Analyser to Repository ([#27](#27)) ([9beaa22](9beaa22)), closes [#10](#10) ### 📝 Documentation * Add Conventional Commits specification ([#75](#75)) ([aa869fc](aa869fc)), closes [#73](#73) * Add README ([#76](#76)) ([03a5f2c](03a5f2c)), closes [#74](#74) ### 🧰 Maintenance * Add .gitattributes for JSON and YAML detection ([#45](#45)) ([1d93833](1d93833)), closes [#41](#41) * Add .prettierignore file to exclude CHANGELOG.md ([#46](#46)) ([203a868](203a868)), closes [#42](#42) * Add code quality workflow and linter configurations ([#25](#25)) ([cfa2a81](cfa2a81)), closes [#9](#9) * Add code test workflow ([#38](#38)) ([3810fc0](3810fc0)), closes [#34](#34) * Add CodeQL Analysis workflow ([#36](#36)) ([acc59f1](acc59f1)), closes [#33](#33) * Add Dependabot Version Updates ([#31](#31)) ([38ec825](38ec825)), closes [#32](#32) * Add Dependency Review workflow ([#37](#37)) ([6f20397](6f20397)), closes [#34](#34) * Add Docker build and test job to code-test workflow ([#66](#66)) ([12f736c](12f736c)), closes [#64](#64) * Add Docker dependency updates and optimise Dockerfile ([#67](#67)) ([20586b8](20586b8)), closes [#65](#65) * Add Dockerfile and Docker build command ([#63](#63)) ([0a189be](0a189be)), closes [#59](#59) * Add EditorConfig ([#20](#20)) ([aa1ea11](aa1ea11)), closes [#2](#2) * Add Git hooks for pre-commit and post-commit checks ([#56](#56)) ([d37c424](d37c424)), closes [#47](#47) * Add GitHub Action ([#68](#68)) ([b203441](b203441)), closes [#58](#58) * Add GitHub issue templates and config ([#55](#55)) ([f86ef79](f86ef79)), closes [#51](#51) * Add Justfile format check to code quality workflow ([#43](#43)) ([9fe1308](9fe1308)), closes [#39](#39) * Add label sync workflow and configuration ([#23](#23)) ([3f12d38](3f12d38)), closes [#7](#7) * Add Markdown link checker to code quality workflow ([#44](#44)) ([7da3500](7da3500)), closes [#40](#40) * Add Output Schema Validation ([#53](#53)) ([1e2599e](1e2599e)), closes [#49](#49) * Add PR labeler workflow and configuration ([#24](#24)) ([c03cbbc](c03cbbc)), closes [#8](#8) * Add Pull Request Template ([#19](#19)) ([03b0fb9](03b0fb9)), closes [#1](#1) * Add Pull Request Title Check ([#21](#21)) ([c44783d](c44783d)), closes [#5](#5) * Add Python code quality checks to workflow ([#30](#30)) ([0ebd090](0ebd090)), closes [#29](#29) * Add schema validation job to code-test workflow ([#54](#54)) ([dd688f4](dd688f4)), closes [#52](#52) * Add SonarCloud scan to code-test workflow ([#62](#62)) ([eebec1a](eebec1a)), closes [#48](#48) * Add Visual Studio Code debug and settings configurations ([#57](#57)) ([9e81f1f](9e81f1f)), closes [#50](#50) * Fix CHANGELOG.md warnings ([#79](#79)) ([44ed05f](44ed05f)), closes [#80](#80) * Fix SonarCloud coverage path and update test commands ([#70](#70)) ([2710fbe](2710fbe)), closes [#69](#69) * init ([fc17219](fc17219)) * Remove version from pyproject.toml ([#77](#77)) ([1d48360](1d48360)), closes [#78](#78) * Rename project to github-stats-analyser ([#61](#61)) ([cb3760f](cb3760f)), closes [#60](#60) * Run Release Please ([#22](#22)) ([829b477](829b477)), closes [#6](#6) * Update Justfile with new tasks and refactor existing ones ([#28](#28)) ([dac1591](dac1591)), closes [#11](#11) * Update Visual Studio Code settings ([#72](#72)) ([ceb7f31](ceb7f31)), closes [#71](#71) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
This pull request adds a new document titled "Conventional Commits 1.0.0" to the project's documentation. The document provides a comprehensive guide on the Conventional Commits specification, which is a lightweight convention for creating structured commit messages.
This addition will help standardise commit messages across the project, making it easier to generate changelogs, determine version bumps, and communicate changes to stakeholders. It also provides guidance for contributors on how to format their commit messages effectively.
fixes #73