Skip to content

Commit

Permalink
fix(readme): commit format (#198)
Browse files Browse the repository at this point in the history
Signed-off-by: Sudhanshu Dasgupta <[email protected]>
  • Loading branch information
sudhanshutech authored Nov 2, 2023
1 parent 61d3c6c commit 0c92055
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,19 @@ Please contribute! Layer5 documentation uses Jekyll and GitHub Pages to host doc
`git push origin <my-changes>`
1. Open a pull request (in your web browser) against the repo.

### Commit Message Format

We follow the [Conventional Commits](https://www.conventionalcommits.org/) standard for our commit messages. Each commit should have a type, an optional scope, and a descriptive message. Examples of commit types include "feat," "fix," "docs," and more.

Here's a basic commit message format:

For example:

- `feat(auth): add user authentication feature`
- `fix(ui): resolve styling issue in the header`

Please ensure that your commits adhere to this format to maintain a clear and organized commit history.

#### Tests

Users can now test their code on their local machine against the CI checks implemented using `make run-tests`.
Expand Down

0 comments on commit 0c92055

Please sign in to comment.