Skip to content

Add introduction section to README.md #678

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
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
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,62 @@

English(TODO) | [中文](https://www.yuque.com/arvinxx-fe/workflow/gitmoji-commit-workflow)

# Introduction

## Overview

Gitmoji Commit Workflow is a tool designed to streamline and standardize the commit process using Gitmoji. It aims to provide a consistent and visually appealing way to manage commits, making it easier to understand the purpose of each commit at a glance.

## Key Features

- **Standardized Commit Messages**: Enforces a consistent commit message format using Gitmoji.
- **Shareable Configurations**: Provides shareable configurations for commitlint, conventional-changelog, and semantic-release.
- **Helper Packages**: Includes helper packages for parser options, commit types, and Gitmoji regex.

## Installation and Setup

To install and set up Gitmoji Commit Workflow, follow these steps:

1. Clone the repository:
```sh
git clone https://github.com/arvinxx/gitmoji-commit-workflow.git
cd gitmoji-commit-workflow
```

2. Install dependencies:
```sh
pnpm install
```

3. Configure your project to use the provided packages and configurations.

## Basic Usage

Here are some basic usage examples to get you started:

- **Commitlint Configuration**:
```sh
echo "module.exports = {extends: ['gitmoji']};" > commitlint.config.js
```

- **Conventional Changelog Configuration**:
```js
// .releaserc.js
module.exports = {
extends: ['semantic-release-config-gitmoji'],
};
```

- **Semantic Release Configuration**:
```js
// .releaserc.js
const { createConfig } = require('semantic-release-config-gitmoji/lib/createConfig');

const config = createConfig({ monorepo: true });

module.exports = config;
```

## Template

Refer to this repository to get a [template](https://github.com/arvinxx/gitmoji-commit-workflow-template) of Gitmoji Commit Workflow
Expand Down
Loading