base_template_cli

Contributing Guideline

Requirements

Tool	Version
Node.js and npm	engines values in package.json
gibo	^2.2.8
Vale CLI	^2.21.3
yamllint	^1.28.0
ShellCheck	>=0.9.0, <1.0.0
actionlint	.tool-versions
Python	.python-version
Pipenv	>=2023.3.20

Rules

Category	Rule
Git commit	Conventional Commits v1.0.0
	@commitlint/config-conventional
Git branching strategy	GitHub flow
Versioning	Semantic Versioning 2.0.0
GitHub PR title	Same as the commit message rule

Development flow

1. Fork this repository
2. Develop and create a Pull Request (PR) according to the preceding rules
3. This repo maintainers will review the PR
4. The maintainers will merge the PR branch if they approved it, otherwise they will close it without merging

Installation

git clone git@github.com:<your org>/base_template_cli.git
cd base_template_cli
make dev-install

Run the script

cd path/to/base_template_cli
pipenv shell

cd src
python -m base_template_cli.main

Lint

make lint

Git commit

npm run commit # Commitizen with commitlint adapter
# or
npm run cm     # Alias for `npm run commit`
# or
git commit     # Standard Git commit

This site is open source. Improve this page.