📖 docs (readme): add git workflow documentation
This commit is contained in:
@@ -45,3 +45,15 @@ The basic development workflow follows these steps:
|
|||||||
### Create Pages in `pages/`
|
### Create Pages in `pages/`
|
||||||
- Pages load the appropriate flow from `components/flows/`.
|
- Pages load the appropriate flow from `components/flows/`.
|
||||||
- They do not contain UI or logic directly, just route level layout or guards.
|
- They do not contain UI or logic directly, just route level layout or guards.
|
||||||
|
|
||||||
|
## Git Workflows
|
||||||
|
The basic git workflow follows these steps:
|
||||||
|
1. Create a new branch on `dev`
|
||||||
|
2. Make your changes
|
||||||
|
3. Commit your changes
|
||||||
|
- commit msg format: `[type]: [description]`
|
||||||
|
- `type` can be `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
|
||||||
|
- `description` should be a brief description of the changes
|
||||||
|
- Example: `feat: add new feature`
|
||||||
|
4. Push your changes to `dev`
|
||||||
|
5. Create a pull request from `dev` to `main`
|
||||||
Reference in New Issue
Block a user