Table of Contents

• About the Project

• Getting Started

  • Prerequisites

  • Installation

• Usage

• Development

  • Development prerequisites
  • Development Installation

• Roadmap

• Contributing

• License

• Contact

• Built With

About The Project

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

In more than three words tell what this package does and how it works.

Getting Started

Prerequisites

• Node
• Yarn

Installation

To install the tool globally:

yarn add @gannochenko/ghtrick -g;

Or, if you want you use it only for the current user:

mkdir ~/.node;
yarn global add @gannochenko/ghtrick --prefix ~/.node;
echo "\nexport PATH=${PATH}:${HOME}/.node/bin\n" >> ~/.bash_profile;
source ~/.bash_profile;

Usage

Just go to the repository you want to have a new version for, and type there:

ghtrick -h;

Development

Development prerequisites

• Node
• Yarn

Development installation

1. Clone the repo

git clone https://github.com/gannochenko/ghtrick.git

2. Install NPM packages

cd ghtrick;
yarn;

3. Run the application

yarn start;

Roadmap

• bugfixing :)

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Sergei Gannochenko - Linkedin

Project Link: https://github.com/gannochenko/ghtrick

Built With

• TypeScript