doc: update README with conventional commits info
This commit is contained in:
parent
aa0e6a1e7f
commit
e3e9832182
14
README.md
14
README.md
|
@ -1,12 +1,24 @@
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
### Quickstart
|
||||||
|
|
||||||
- `npm install`, the postinstall runs
|
- `npm install`, the postinstall runs
|
||||||
- `npm run rebuild`
|
- `npm run rebuild`
|
||||||
- might need to install some build tools depending on your platform
|
- might need to install some build tools depending on your platform
|
||||||
- `npm run typeorm:migrate` for installing the database
|
- `npm run typeorm:migrate` for installing the database
|
||||||
- `npm run tsc` for backend
|
- `npm run tsc` for backend
|
||||||
- `npm run webpack` for frontend
|
- `npm run webpack` for frontend
|
||||||
- `npm dev`
|
- `npm run dev`
|
||||||
|
|
||||||
|
### Git Commits
|
||||||
|
|
||||||
|
This project uses [Conventional Commits](https://www.conventionalcommits.or) with the following types:
|
||||||
|
- `feat`: features, if any part of your commit implements a new function, use this
|
||||||
|
- `fix`: bugfixes
|
||||||
|
- `doc`: documentation
|
||||||
|
- `refactor`: code refactoring
|
||||||
|
|
||||||
|
Always try to split up your changes into coherent commits, a single commit should do a single thing.
|
||||||
|
|
||||||
### Database Migrations
|
### Database Migrations
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue