Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
omermujtaba18 committed Aug 28, 2024
1 parent 26f6598 commit 5d45d7e
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,36 @@ $ npm run test:e2e
$ npm run test:cov
```

## Documentation
## API Swagger Documentation

API documentation is available at http://localhost:3000/api-docs

## Commit Message Guide

### Commit Message Format

```
<type>(<scope?>): <subject>
```

#### Type

Must be one of the following:

- build: Changes that affect the build system or external dependencies (example scopes: node, npm)
- chore: Updating tasks etc; no production code change
- gh-actions: Changes to .github files and scripts (example scopes: ci, dependabot etc.)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests

#### Scope

- common: for changes made on src/common directory
- config: for changes made on src/config directory
- resources: for changes made on src/resources directory
- lib: for changes made on root/libs directory

0 comments on commit 5d45d7e

Please sign in to comment.