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.
Create or update your CHANGELOG.md with a single command.
License: MIT License
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.
As a Developer
So that I can read the commit log conveniently,
I would like to save the log to a file
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.
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
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.
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.
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
### 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
A CHANGELOG.md
should be created and correctly formatted based on conventional commits and the example above.
As a Developer,
So that I can see what version commits relate to,
I would like versions as headings
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.