Skip to content

Commit

Permalink
chore(precommit): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GitLukeW committed Oct 1, 2023
1 parent 8e33b49 commit 12e4ff1
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Branch names should be in the following format:

**Type:** The type of branch. This should be one of the following:

- feature - Adding a new feature
- feat - Adding a new feature
- bugfix - Fixing bugs in the code
- hotfix - For emergency fixes
- test - Experimental changes for testing purposes
Expand All @@ -181,20 +181,25 @@ Branch names should be in the following format:

Commit messages should be in the following format:

`<type>(<specific fix>): <description>`
`<type>(<scope>): <description>`

**Type:** The type of commit. This corrospoinds to the type of branch.
**Type:** Represents the type of change that was made. This should be one of the following:

**Specific Fix:** The specific fix that was made. This should be one of the following:

- add - Adding new files or code
- update - Updating existing files or code
- remove - Removing files or code
- feat - Adding a new feature
- fix - Fixing bugs in the code
- refactor - Refactoring existing code
- styled - Formatting, missing semi colons, etc; no code change

**Description:** A short description of the commit. This should be in lowercase and use dashes instead of spaces.
- docs - Changes to documentation
- style - Changes to code style
- refactor - Changes to code that neither fixes a bug nor adds a feature
- perf - Changes to code that improves performance
- test - Adding or updating tests
- build - Changes to the build process or dependencies
- ci - Changes to CI configuration files and scripts
- chore - Miscellaneous changes, such as updating packages or bumping a version number
- revert - Reverting a previous commit

**Scope:** This is optional but can provide additional contextual information. It describes the section or aspect of the codebase affected by the change. For example, auth for authentication-related changes or header for changes to a website's header component.

**Description:** A concise description of the changes. Start with a lowercase verb indicating what was done (e.g., add, update, remove, fix).

# API Reference

Expand Down

0 comments on commit 12e4ff1

Please sign in to comment.