search

brdevstreamers / brdevstreamers-ui

https://brstreamers.dev
Apache License 2.0
60 stars 20 forks source link

Feature/commit validation #46

Closed ehcorrea closed 2 years ago

ehcorrea commented 2 years ago

Add tools to assist with files and commits patterns.

Used libs: cz-cli husky commitlint lint-staged

How to use

  1. Add files to Staged Changes 1
  2. Run the command git commit(without -m) and wait for the lint staged command to finish, this will validate that your files are written according to eslint rules 2
  3. Error case exemple. The commit process will stop until there are no warnings/errors 2.5 - caso seja encontrado algum erro nos arquivos
  4. Select the type of change, you can see with more details in changelog.config.json 3
  5. Describe your commit based on the questions, not all are required 4
  6. Final output exemple 5
  7. Git exemple, you can se more details here 6
NandoSangenetto commented 2 years ago

Could you please add instructions in our README.md file?

ehcorrea commented 2 years ago

Could you please add instructions in our README.md file?

@nandosangenetto Would you like a simplified version with only written instructions or with images?

NandoSangenetto commented 2 years ago

Could you please add instructions in our README.md file?

@nandosangenetto Would you like a simplified version with only written instructions or with images?

Simplified version is enough :)

ehcorrea commented 2 years ago

@nandosangenetto done 👍🏾

NandoSangenetto commented 2 years ago

Well done