Skip to content

Commit fe98dfc

Browse files
CodeWithTheDoctorjsun1590
authored andcommitted
docs: fixed documentation formatting
1 parent 2690715 commit fe98dfc

1 file changed

Lines changed: 22 additions & 22 deletions

File tree

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -160,33 +160,33 @@ feat(core): add hat wobble
160160
More types can be added if neccessary in the `commitlint.config.js` file.
161161

162162
The commit type must be of the following:
163-
feat: (new feature for the user, not a new feature for build script)
164-
fix: (bug fix for the user, not a fix to a build script)
165-
docs: (changes to the documentation)
166-
style: (formatting, missing semi colons, etc; no production code change)
167-
refactor: (refactoring production code, eg. renaming a variable)
168-
test: (adding missing tests, refactoring tests; no production code change)
169-
chore: (updating grunt tasks etc; no production code change)
170-
build: (changes related to the build process)
171-
perf: (increasing performance)
172-
revert: (reverting a commit)
173-
ci: (continuous integration related changes. We won't be using this; instead we will be using the ci and cd scopes for devops related changes.)
163+
- `feat:` (new feature for the user, not a new feature for build script)
164+
- `fix:` (bug fix for the user, not a fix to a build script)
165+
- `docs:` (changes to the documentation)
166+
- `style:` (formatting, missing semi colons, etc; no production code change)
167+
- `refactor:` (refactoring production code, eg. renaming a variable)
168+
- `test:` (adding missing tests, refactoring tests; no production code change)
169+
- `chore:` (updating grunt tasks etc; no production code change)
170+
- `build:` (changes related to the build process)
171+
- `perf:` (increasing performance)
172+
- `revert:` (reverting a commit)
173+
- `ci:` (continuous integration related changes. We won't be using this; instead we will be using the ci and cd scopes for devops related changes.)
174174

175175
#### Scopes
176176

177177
More scopes can be added if neccessary in the `commitlint.config.js` file. If there are overlapping scopes in your commit/pull request, choose the most suitable scope.
178-
178+
<br>
179179
The commit scope must be of the following or blank:
180-
core: (core functionality changes)
181-
linting: (linting related changes)
182-
frontend: (frontend changes)
183-
backend: (backend changes)
184-
auth: (authenication changes)
185-
styles: (changes to the styling)
186-
config: (changes to the configuration)
187-
misc: (other miscellaneous changes)
188-
ci: (changes to the continuous integration)
189-
cd: (changes to the continuous delivery)
180+
- `core:` (core functionality changes)
181+
- `linting:` (linting related changes)
182+
- `frontend:` (frontend changes)
183+
- `backend:` (backend changes)
184+
- `auth:` (authenication changes)
185+
- `styles:` (changes to the styling)
186+
- `config:` (changes to the configuration)
187+
- `misc:` (other miscellaneous changes)
188+
- `ci:` (changes to the continuous integration)
189+
- `cd:` (changes to the continuous delivery)
190190

191191
## Writing documentations
192192

0 commit comments

Comments
 (0)