docs: add commit message guidelines (#208)

Signed-off-by: Akshay Gaikwad <akgaikwad001@gmail.com>
2026-08-24 15:47:19 +00:00 · 2023-05-24 14:57:25 +05:30
parent 222cf9d317
commit 13d60ad090
1 changed files with 99 additions and 2 deletions
@@ -140,7 +140,104 @@ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
 ```
 - Run `make build-proto` to regenerate proto artifacts

-## DCO Sign off
+# Commit Message Guidelines
+
+Paralus uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+## Commit Message Format
+
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a type, a scope and a subject:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+Samples:
+
+```
+build(deps): update kratos sdk to v0.11.0
+```
+
+```
+feat: support SAML based IdP
+
+New support for SAML based IdP. More deatils about how to configure SAML IdP is availble at paralus.io/docs/saml
+
+Closes #111
+```
+
+```
+fix(core): incorrect status code for user API
+
+Fix incorrect 500 HTTP status code for user GET API request with invalid parameters.
+
+Closes #89
+```
+
+## Message Header
+
+The header is mandatory and the scope of the header is optional.
+
+Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
+
+### Type
+
+Must be one of the following:
+
+- **build**: Changes that affect the build system or external dependencies (example scopes: go, npm).
+- **chore**: Routing changes such as version update in docs, update changelog.
+- **ci**: Changes to CI configuration files and scripts.
+- **docs**: Documentation changes.
+- **feat**: A new feature.
+- **fix**: A bug fix.
+- **perf**: A code that improves performance.
+- **refactor**: A code change that neither fixes a bug nor adds a feature.
+- **revert**: Reverts a previous commit.
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting etc).
+- **test**: Adding missing tests or correcting existing tests.
+
+### Scope
+
+Scope is an optional in commit message. The following is the list of supported scopes:
+  ```
+  TBD
+  ```
+
+### Subject
+
+The subject contains a succinct description of the change:
+
+  - use the imperative, present tense: "change" not "changed" nor "changes"
+  - don't capitalize the first letter
+  - no dot (.) at the end
+  
+## Message Body
+
+Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
+
+## Message Footer
+
+The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE: ` with a space. The rest of the commit message is then the description of the change, justification and migration notes.
+
+Closed bugs should be listed on a separate line in the footer prefixed with "Closes" keyword like this:
+
+```
+Closes #177
+```
+
+or in case of multiple issues:
+
+```
+Closes #177, #200, #251
+```
+
+# DCO Sign off

 All authors to the project retain copyright to their work. However, to ensure
 that they are only submitting work that they have rights to, we are requiring
@@ -201,6 +298,6 @@ By making a contribution to this project, I certify that:
    this project or the open source license(s) involved.
 ```

-## Need Help?
+# Need Help?

 If you are interested to contribute to core but are stuck with any of the steps, feel free to reach out to us. Please [create an issue](https://github.com/paralus/paralus/issues/new) in this repository describing your issue and we'll take it up from there.