https://github.com/thejoin95/wdyd
A node CLI utility to write via interface great commit message (conventional commit guidelines)
https://github.com/thejoin95/wdyd
Last synced: 10 months ago
JSON representation
A node CLI utility to write via interface great commit message (conventional commit guidelines)
- Host: GitHub
- URL: https://github.com/thejoin95/wdyd
- Owner: TheJoin95
- License: apache-2.0
- Created: 2022-07-27T15:22:21.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-16T18:10:18.000Z (over 3 years ago)
- Last Synced: 2025-08-24T08:28:19.320Z (10 months ago)
- Language: JavaScript
- Size: 68.4 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WDYD - What Did You Do?
[](http://badge.fury.io/js/wdyd)
A node CLI utility to write via CLI & Interactive interface great commit message (conventional commit guidelines).
This utility will guide you to create a great commit message, body & footer following the Conventional Commits guideline.
Communication & transparancy is the key when you are working in an AGILE env or in a team.
# Goal
Increase the knoledge across the community and the opensource world for the [conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/).
# Getting Started
## Installation
`npm i -g wdyd`
## How to use it
Go to your project directory, add your changes via `git add` command.
There are two mode to run WDYD: interactive and manual.
### Interactive
Run the following command:
`wdyd interactive`
It will ask you couple of questions regarding what did you do in your projects, what have you changed and why, as follow:
```
- What scope did you focus on?
- Describe your change in an emperative way:
- Include the motivation for the change and contrast this with previous behavior:
- Type The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes:
```
At the end of the questions it will generate a commit printing out the stdout.
### Manual
Run the following command to get a list of commands:
`wdyd -h`
```
Usage: wdyd [options] [command]
What Did You Do - A node CLI utility to write via interface great commit message (conventional commit guidelines)
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
build [body] [footer] Changes that affect the build system or external dependencies (example scopes:
gulp, broccoli, npm)
chore [body] [footer] Upgrading, migrating, deprecating a dependency or packages
ci [body] [footer] Changes to our CI configuration files and scripts (example scopes: Travis,
Circle, BrowserStack, SauceLabs)
docs [body] [footer] Documentation only changes
feat [body] [footer] A new feature
fix [body] [footer] A bug fix
perf [body] [footer] A code change that improves performance
refactor [body] [footer] A code change that neither fixes a bug nor adds a feature
revert [body] [footer] Going back specifying what went wrong and when
style [body] [footer] Changes that do not affect the meaning of the code (white-space, formatting,
missing semi-colons, etc)
test [body] [footer] Adding missing tests or correcting existing tests
interactive Create your commit in a interactive env
help [command] display help for command
```
In order to get a command documentation you can run:
`wdyd build -h`
**Example**
Let's say I made some changes on a new feature:
`wdyd feat api 'add user auth services'`
Or, if I need to update a dependency that might lead to some deprecations:
`wdyd chore '!deps' 'upgrade to react18' 'Alignment with other microfrontends repositories' 'BREAKING CHANGE: no more class components'`
# Notes
A lot of references are taken from conventional commits projects & plugin for VSCode.
# Author
[@thejoin95](https://github.com/thejoin95)