Skip to content

Commit cdd2472

Browse files
committed
Add introduction section to README.md
Fixes #677 Add an introduction section to the `README.md` file. - **Overview**: Provide a brief overview of the project and its objectives. - **Key Features**: List key features and functionalities. - **Installation and Setup**: Include instructions for installation and setup. - **Basic Usage**: Add basic usage examples or a quick start guide. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/arvinxx/gitmoji-commit-workflow/issues/677?shareId=XXXX-XXXX-XXXX-XXXX).
1 parent 8f21e28 commit cdd2472

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

+56
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,62 @@
3131

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

34+
# Introduction
35+
36+
## Overview
37+
38+
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.
39+
40+
## Key Features
41+
42+
- **Standardized Commit Messages**: Enforces a consistent commit message format using Gitmoji.
43+
- **Shareable Configurations**: Provides shareable configurations for commitlint, conventional-changelog, and semantic-release.
44+
- **Helper Packages**: Includes helper packages for parser options, commit types, and Gitmoji regex.
45+
46+
## Installation and Setup
47+
48+
To install and set up Gitmoji Commit Workflow, follow these steps:
49+
50+
1. Clone the repository:
51+
```sh
52+
git clone https://github.com/arvinxx/gitmoji-commit-workflow.git
53+
cd gitmoji-commit-workflow
54+
```
55+
56+
2. Install dependencies:
57+
```sh
58+
pnpm install
59+
```
60+
61+
3. Configure your project to use the provided packages and configurations.
62+
63+
## Basic Usage
64+
65+
Here are some basic usage examples to get you started:
66+
67+
- **Commitlint Configuration**:
68+
```sh
69+
echo "module.exports = {extends: ['gitmoji']};" > commitlint.config.js
70+
```
71+
72+
- **Conventional Changelog Configuration**:
73+
```js
74+
// .releaserc.js
75+
module.exports = {
76+
extends: ['semantic-release-config-gitmoji'],
77+
};
78+
```
79+
80+
- **Semantic Release Configuration**:
81+
```js
82+
// .releaserc.js
83+
const { createConfig } = require('semantic-release-config-gitmoji/lib/createConfig');
84+
85+
const config = createConfig({ monorepo: true });
86+
87+
module.exports = config;
88+
```
89+
3490
## Template
3591

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

0 commit comments

Comments
 (0)