https://github.com/gforti/standard-version-test

https://github.com/gforti/standard-version-test

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/gforti/standard-version-test
• Owner: gforti
• Created: 2020-01-09T14:27:47.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-11T21:16:21.000Z (over 3 years ago)
• Last Synced: 2024-05-28T16:18:31.663Z (7 months ago)
• Language: HTML
• Size: 225 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Automated CHANGELOG

This is a test branch to try out `standard-version`

### References

- https://github.com/conventional-changelog/standard-version

- https://www.conventionalcommits.org/en/v1.0.0/

- https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines

- https://medium.com/@menuka/writing-meaningful-git-commit-messages-a62756b65c81

## Install

```sh

$ npm install standard-version --save-dev

```

Add a script

```json

"scripts": {

    "release": "standard-version"

  }

```

Run the Script

```sh

$ npm run release

```

## Quick rundown

Message that will be used for Features and Bug Fixes

> feat: this is a feature added

> fix: this is a bug fix

Add an exclamation(!) to indicate breaking changes

> feat!: this is a breaking change feature

Use `refactor:` when making small commits

## Types of commit messages:

- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)

- ci: Changes to CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)

- docs: Documentation only changes

- feat: A new feature

- fix: A bug fix

- perf: A code change that improves performance

- refactor: A code change that neither fixes a bug nor adds a feature

- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

- test: Adding missing tests or correcting existing tests