These guidelines aim to have a good and standardized way to write and commit code.
Each tool created in the team has to be as a Python module: easy to install, easy to deploy. A skeleton is available at https://github.com/brsynth/module.
Having good (browseable and readable) commits guarantees a reliable collaborative work in space and time. To address this topic, we use Commitizen to have standardized and readable commits in our projects.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
- On macOS:
brew install npm
- On Debian-like:
apt-get install npm
- On Alpine-like:
apk add npm
npm install commitizen -g
npm init
commitizen init cz-conventional-changelog --save-dev --save-exact
To avoid footprint in the project repository, add npm files into the .gitignore
file:
package.json
package-lock.json
node_modules
Replace your usual commit command (e.g. git commit -am
) by:
git cz -am