coding-guidelines.md

Coding guidelines

Configuring Git's line ending handling

This cofniguration converts LF to CRLF when checking out in Windows systems and CRLF to LF when committing.

# Global Configuration: Applies the settings to all repositories on your system.
git config --global core.autocrlf true

# Local Configuration: Applies the settings only to the current repository.
git config core.autocrlf true

prettier and linter

The project will run the prettier and linter before a commit with husky, if the .husky folder exists in the project root. Otherwise, you can create it with the following commands:

npx husky install
npx husky add .husky/pre-commit "npm run pre-commit"

Commit changes

The application uses a linter for commit messages, requiring them to be specified in the following format:

- [type] message
- [type] :icono: message

Example:

- commit -m [chore] add commitlinter
- commit -m [chore] :sparkles: add commitlinter (to commit with an icon, you can use [gitmoji](https://gitmoji.dev/))

The allowed standard types are:

- feat: A new feature for the user.
- fix: Fixes a bug that affects the user.
- perf: Changes that improve site performance.
- build: Changes in the build system, deployment tasks, or installation.
- ci: Changes in continuous integration.
- docs: Changes in documentation.
- refactor: Code refactoring such as variable or function name changes.
- style: Changes in formatting, tabs, spaces, or semicolons, etc.; do not affect the user.
- test: Adds tests or refactors an existing one.
- chore: Other changes that don't modify src or test files.
- revert: Reverts a previous commit.

Failing to comply with these standards will cause the pre-commit to fail. To remove the last commit (without losing changes), run:

git reset --soft HEAD~1

For more information, refer to: commitlint.