Templates
GitHub

Github

Readme

 
# 🔥 **GitHub Project ...**
 
---
 
## 🤔 **What is this project?**
 
 
---
 
## ARCHITECTURE CLOUD AWS
 
 
## ⚡ **Installation**
 
1. Prerequires
2. Clone repository
3. Install packages
4. Install prepare config
6. Usage
---
 
## Usage Docker compose
0. Prerequires
- Install Docker
- Install Docker compose version > 2.45.x
 
1. Setup environment (config .env file)
2. Docker compose
3. Check mysql database
 
## 📚 **What does it include?**
 
---
 
### 🌲 **Project tree**
 
---
 
## 📝 **Additional notes**
 
### 📌 **API Documentation**
 
### 📌 **Database**
 
---
## 📖 **Information**
 
## ❔ **How to push**
 
- Role commit
  `{type}: {subject}`
  - type: build | chore | ci | docs | feat | fix | perf | refactor | revert | style | test
  - subject: 'Write a short, imperative tense description of the change'
- Automatic: check lint and format pre-commit
 
- Example:
 
Description
|**Types**| **Description** |
|:---| :--- |
|feat| A new feature|
|fix| A bug fix|
|docs| Documentation only changes|
|style| Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
|refactor| A code change that neither fixes a bug nor adds a feature |
|perf| A code change that improves performance |
|test| Adding missing tests or correcting existing tests |
|build| Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
|ci| 'Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
|chore| Other changes that don't modify src or test files |
|revert| Reverts a previous commit |
 

Pull Request

---
title: "[env]/[issue_id]: [description]"
assignees: 
---
 
## Related Tickets & Documents
- Related Issue #xx (e.g. #99)
- Closes #xx (e.g. #99)
 
## What type of PR is this? (check all applicable)
- [ ] Refactor
- [ ] Feature
- [ ] Bug Fix
- [ ] Optimization
- [ ] Documentation Update
 
## PR Checklist
_(*)Please check if your PR fulfills the following requirements:_
- [x]  PR title format name : `[env] [description]`. Eg `[dev] Api login`
- [ ] The commit message follows our guidelines:
- [x] Update swagger
 
## Description
_(*) Break down detail steps by step you will implement. As detail as good_
 
- [x] split swagger to reduce lines in controllers
- [x] Format entities migrations.
 
## QA Instructions, Screenshots, Recordings
_Please replace this line with instructions on how to test your changes, a note
on the devices and browsers this has been tested on, as well as any relevant
images for UI changes._
 
## [optional] Are there any post deployment tasks we need to perform?
 
## [optional] What gif best describes this PR or how it makes you feel?