This repository serves as a template for creating new projects here at @nantli. It provides a basic structure and guidelines to help you get started quickly. Feel free to customize it to fit your specific needs.
- Clone this repository using the
git clonecommand. - cd into the repository
- Run
devbox shellto start the development environment
Goodcommit is a cli tool that allows you to create commit messages in a structured way. After stagging your changes, run goodcommit or the alias gc and follow the prompts to create a commit message and commit the changes.
The configuration file is located in the .repo/configs directory. Goodcommit uses modules to build a commit message, and the file config.json contains the parameters for configuring each module. To learn more about configuring goodcommit modules, see the goodcommit documentation.
Two modules that you most likely will configure very early on are 'types' and 'scopes'. Do this by editing the commit_types.json and commit_scopes.json files under the .repo/configs directory. The idea of these modules is to follow the conventions of conventional commits. So feel free to add new types and scopes as you see fit.
This repository uses pre-commit hooks to ensure that the code is formatted and linted properly. To run the pre-commit hooks, run task precommit or pc. Otherwise, the pre-commit hooks will run automatically when you make a commit.
The pre-commit hooks are configured using the .pre-commit-config.yaml file in .repo directory. The idea of this file is to ensure that the code is formatted and linted properly. To learn more about configuring pre-commit hooks, see the pre-commit documentation.