Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

changelog 3 #28

Merged
merged 3 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 35 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,33 @@

All notable changes to this project will be documented in this file.

## [0.1.0-rc.2] - 2024-08-28

### 🚀 Features

- *(git-cz)* Add optional footer prompt
- *(cargo-dist)* Install prebuilt binaries via homebrew
- *(cargo-dist)* Install prebuilt binaries via powershell

### 🐛 Bug Fixes

- *(cargo)* Add openssl as a vendored dependencies

### 🚜 Refactor

- Rename module in main.rs and test_main.rs

### 📚 Documentation

- *(README)* Add shell installation
- Add assets

### ⚙️ Miscellaneous Tasks

- *(cargo)* Bump rc version
- *(cargo)* Rename package-name and add bin section
- *(cargo)* Add license-file

## [0.1.0-rc.1] - 2024-08-27

### 🚜 Refactor
Expand All @@ -23,9 +50,15 @@ All notable changes to this project will be documented in this file.

## [unreleased]

The unreleased version was a bash script with gum.
You can find the bash script [here](https://github.com/k3ii/git-cz/blob/30f8aae0fbe0516af81b948201d29a5877d0a95e/git-cz).

### 🚀 Features

- *(git-cz)* Display commit information
- *(git-cz)* Add option to automatically stage files
- *(git-cz)* Add more types
- *(git-cz)* Add initial git-cz

### 🐛 Bug Fixes

Expand All @@ -39,23 +72,10 @@ All notable changes to this project will be documented in this file.
- *(README)* Update examples to include image
- *(images)* Add image examples
- *(README)* Fix heading typo conventiona -> conventional

### Docs

- *(README)* Update installation instruction

## [0.1.0] - 2024-08-23

### 🚀 Features

- *(git-cz)* Add option to automatically stage files
- *(git-cz)* Add more types
- *(git-cz)* Add initial git-cz

### 📚 Documentation

- *(README)* Add contributing section
- *(README)* Update README with installation instruction
- *(README)* Update installation instruction


### ⚙️ Miscellaneous Tasks

Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,12 @@ It prompts you to select the type of commit, enter a scope (optional), and provi
## Installation

```bash
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/k3ii/git-cz/releases/download/0.1.0-rc.1/git-cz-installer.sh | sh
cargo install git-commitizen
```
> [!NOTE]
> Although the package is called `git-commitizen` on crates.io, the installed binary is named `git-cz`:

Check [releases](https://github.com/k3ii/git-cz/releases) for pre-built binaries or compiled binary for your platform.

## Conventional Commits

Expand All @@ -31,12 +35,15 @@ A conventional commit message has the following format:
<type>(<scope>): <summary>

<body>

<footer>
```

- `type`: The type of change being committed, e.g., feat, fix, docs, etc.
- `scope` (optional): The part of the codebase that is being affected.
- `summary`: A brief summary of the change.
- `body` (optional): A detailed description of the change.
- `footer` (optional): A footer section that can contain additional information about issues fixed or closed.

Benefits

Expand Down
59 changes: 0 additions & 59 deletions git-cz

This file was deleted.

107 changes: 0 additions & 107 deletions install

This file was deleted.