diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4ae6303..a0f332a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -3,9 +3,38 @@ Follow the [Meme Battle styleguide](https://github.com/Meme-Battle/styleguide/blob/main/git.md). ## Folder Structure (general) ## - - - -``` -README.md - You are here! +``` +. +├── api +│ ├── prisma +│ │ ├── migrations +│ │ └── schema.prisma +│ └── src +│ ├── app.controller.ts +│ ├── app.module.ts +│ ├── app.service.ts +│ ├── main.ts +│ └── modules +│ ├── gateways +│ │ ├── gatewayExample.gateway.ts +│ │ └── gateways.module.ts +│ ├── guards +│ │ ├── guardExample.guard.ts +│ │ └── guards.module.ts +│ ├── providers +│ │ ├── providerExample.provider.ts +│ │ └── providers.module.ts +│ ├── repositories +│ │ ├── repositories.module.ts +│ │ └── repositoryExample.repository.ts +│ └── useCases +│ └── useCaseExample +│ ├── CreateExample +│ │ ├── createExample.controller.ts +│ │ ├── createExample.dto.ts +│ │ ├── createExample.schema.ts +│ │ └── createExample.service.ts +│ └── useCaseExample.module.ts +├── CHANGELOG.md +└── README.md ``` \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index beea7a7..4a598b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Create the PULL_REQUEST_TEMPLATE.md [MBU-10](https://memebattle.atlassian.net/browse/MBU-10) - Create the project setup [MBU-3](https://memebattle.atlassian.net/browse/MBU-3) - -### Fixed - -- Fixed Commitlint and Husky settings [MBU-3](https://memebattle.atlassian.net/browse/MBU-3) \ No newline at end of file +- Add content in the contributing file:structure of project [MBU-7](https://memebattle.atlassian.net/browse/MBU-7) +- Fixed Commitlint and Husky settings [MBU-3](https://memebattle.atlassian.net/browse/MBU-3)