Code Monkey home page Code Monkey logo

changelog's Introduction

My desk setup

Hey there! I'm a Software Engineer, working on a large-scale industry leading financial product. As part of the Feature Team, I deliver features and squash bugs.

You can get in touch with me @madebyibrahim or leave an issue.

changelog's People

Contributors

dependabot[bot] avatar ibrahimbutt avatar

Stargazers

avatar avatar

changelog's Issues

Setup project

Description

TypeScript will be used, requiring:

  • typescript
  • ts-node
  • @types/node

Jest will be used, requiring:

  • jest
  • ts-jest
  • @types/jest

Travis will be used for CI/CD.

Add sections for versions 

As a Developer,
So that I can see what version commits relate to,
I would like versions as headings

Add sections for feature and fix commits 

As a Developer,
So I can see the features added and bugs fixed at a glance,
I would like an Added and Fixed section

Commits that are of the type feat, should be under ## Added. Commits of the type fix should be under ## Fixed. All other types of commits should be ignored, as they are not relevant to a changelog.

v1.0.0

Description

v1.0.0 will produce a CHANGELOG.md. It will list commits under the version and commit types:

  • feat
  • fix

For this to work, commits will need to be based on Conventional Commits.

Examples

Commit Log

Using git log --pretty=format:"%s %d %aD":

chore(release): release 1.1.0 (tag: v1.1.0) Fri, 21 Jun 2019 18:57:10 +0100
feat: option to hide device serial Fri, 21 Jun 2019 18:57:10 +0100
fix(device): retrieve name correctly Fri, 21 Jun 2019 18:57:10 +0100
chore(release): release 1.0.0 (tag: v1.1.0) Fri, 20 Jun 2019 18:57:10 +0100
feat: device serial getter Fri, 20 Jun 2019 18:57:10 +0100
feat: device name getter and setter Fri, 20 Jun 2019 18:57:10 +0100

Changelog

### v1.1.0 – 21 Jun 2019

#### Added

- option to hide device serial

#### Fixed

- **device**: retrieve name correctly

### v1.0.0 – 20 Jun 2019

#### Added

-  device serial getter
-  device name getter and setter

Acceptance Criteria

A CHANGELOG.md should be created and correctly formatted based on conventional commits and the example above.

Save log to file 

As a Developer
So that I can read the commit log conveniently,
I would like to save the log to a file

Retrieve formatted commit log 

As a Developer,
So that I can create a changelog
I would like to have the commit log

As a Developer,
So that I can easily read the commits
I would like commits to be formatted by subject then hash

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.