From aa304fbda8d41eb4a99826970e162ad95400a7ca Mon Sep 17 00:00:00 2001 From: SEMIN Date: Thu, 2 Jan 2025 23:07:10 +0900 Subject: [PATCH 1/9] docs: update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 106 +++++++++++++++++++++++++++++++++++----- 1 file changed, 95 insertions(+), 11 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c907ff5..800884c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,18 +1,102 @@ # Contributing to Sipe Design System -We love your input! We want to make contributing to this project as easy and transparent as possible. This document outlines the process for contributing to our component library. +Welcome to our project! We want to make contributing to this project as easy and transparent as possible. +This document provides a clear guide on **how to contribute to Sipe Design System**. +We've outlined the process to ensure contributing is as easy and transparent as possible. + +--- ## Getting Started -1. Fork the repository -2. Clone your fork: `git clone https://github.com/your-username/3-1_sds.git` -3. Install dependencies: `pnpm install` +### Fork and Clone the Repository +First, fork the repository and then clone it locally: +```sh +git clone https://github.com/your-username/3-2_side.git +``` + +### Install Dependencies +Install the necessary dependencies: +```sh +pnpm install +``` + +### Run Development Server +Run the development server to verify the setup: +```sh +pnpm dev +``` + +--- + +## Developing + +### Create New Components +Use the CLI to create new components. The generated components will be placed under the `packages/` directory: +```sh +pnpm create:component +``` + +- **Naming Convention:** Use kebab-case for component names (e.g., `my-button`). +- **Styling:** Prioritize using predefined styles from the `tokens` package. + +### Testing +We use **Vitest** for testing. +All new features or changes must include **relevant test cases**. +```sh +pnpm test +``` + +### Storybook +We use **Storybook** for visual testing of components. +All components must include Storybook documentation. +Run the following command to view your components at `localhost:6006`: +```sh +pnpm dev:storybook +``` + +--- + +## How to Propose Changes +Before proposing changes, please **open an issue** to discuss the bug or feature. + +### Create a Pull Request + +1. **Create a Branch** + Follow the branch naming convention: `/` + ```sh + git checkout -b feat/your-feature + ``` + +2. **Commit Changes** + Write meaningful commit messages: + ```sh + git commit -m "feat: description" + ``` + +3. **Push Changes** + Push the branch to your forked repository: + ```sh + git push -u origin HEAD + ``` + +4. **Submit Pull Request (PR)** + - Follow the PR template. + - Provide a detailed description of your changes. + +### Code Review & Feedback +- Address feedback from reviewers promptly. +- Push additional commits directly to the PR branch. + +--- + +## Issue Reporting + +We use **GitHub Issues** to track and manage problems and discussions. +Please register your issue so we can discuss and decide on the next steps. -## Creating a New Component +### Bug Reporting +- Check if a similar issue already exists. +- Clearly describe **reproduction steps**, **expected results**, and **actual results**. -1. Copy the [.templates/component](.templates/component) folder to `packages/your-component-name` -2. Follow the test-driven development process: - - Write test cases first in `src/Component.test.tsx` - - Implement the component to pass the tests - - Create stories in Storybook for documentation -3. Run the test suite: `pnpm test` \ No newline at end of file +### Feature Suggestions +- Describe the purpose and expected outcome of the feature in detail. From 03f9855584220f24816009f8f45109cd3477b62a Mon Sep 17 00:00:00 2001 From: SEMIN Date: Wed, 8 Jan 2025 00:01:55 +0900 Subject: [PATCH 2/9] docs: add introduction to Side (Sipe Design System) --- .github/CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 800884c..78ca9ea 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,9 +1,12 @@ # Contributing to Sipe Design System Welcome to our project! We want to make contributing to this project as easy and transparent as possible. -This document provides a clear guide on **how to contribute to Sipe Design System**. +This document provides a clear guide on **how to contribute to Side(Sipe Design System)**. We've outlined the process to ensure contributing is as easy and transparent as possible. +### What is Side? +Side refers to the Sipe Design System, our primary UI component library aimed at creating consistent and reusable interfaces. + --- ## Getting Started From cbba77b9ad959ece2c5c96922d5b5c65e28078fb Mon Sep 17 00:00:00 2001 From: SEMIN Date: Wed, 8 Jan 2025 22:47:35 +0900 Subject: [PATCH 3/9] docs: remove development server setup instructions --- .github/CONTRIBUTING.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 78ca9ea..15ceaca 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -23,12 +23,6 @@ Install the necessary dependencies: pnpm install ``` -### Run Development Server -Run the development server to verify the setup: -```sh -pnpm dev -``` - --- ## Developing From ae2b9c49b59c052c777ffe270213a727d1497eb3 Mon Sep 17 00:00:00 2001 From: SEMIN Date: Wed, 8 Jan 2025 23:13:51 +0900 Subject: [PATCH 4/9] docs: add repository URL for forking instructions --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 15ceaca..b9b0754 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,7 +12,7 @@ Side refers to the Sipe Design System, our primary UI component library aimed at ## Getting Started ### Fork and Clone the Repository -First, fork the repository and then clone it locally: +First, fork the [repository](https://github.com/sipe-team/3-2_side) and then clone it locally: ```sh git clone https://github.com/your-username/3-2_side.git ``` From 513c616c25a0e88ccce43252a4e7b945a51f61b7 Mon Sep 17 00:00:00 2001 From: SEMIN Date: Wed, 8 Jan 2025 23:14:39 +0900 Subject: [PATCH 5/9] docs: add commit message convention guidelines --- .github/CONTRIBUTING.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b9b0754..88c46e1 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -65,10 +65,28 @@ Before proposing changes, please **open an issue** to discuss the bug or feature ``` 2. **Commit Changes** - Write meaningful commit messages: + Write meaningful commit messages using the [Conventional Commits](https://www.conventionalcommits.org/) format: ```sh - git commit -m "feat: description" + git commit -m "(): " ``` + We recommend following the Conventional Commits standard for clear and consistent commit messages. Below is the suggested structure: + + + - `` (Required) + - Indicates the purpose or type of the commit. + - Examples: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore` + + - `` (Optional) + - Specifies the scope of the changes, such as the module, file name, or functionality affected. + - Limited to a maximum of 20 characters. + + - `` (Required) + - A brief summary of the changes made. + - Limited to 50 characters. + - Starts with a lowercase letter. + - Do not end with a period(.). + - Written in English. + 3. **Push Changes** Push the branch to your forked repository: From 7455122f0bbb2ae32ee0d9b328afad52d9245daf Mon Sep 17 00:00:00 2001 From: SEMIN Date: Wed, 8 Jan 2025 23:21:20 +0900 Subject: [PATCH 6/9] docs: add protocol to Storybook local URL --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 88c46e1..0113ece 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -46,7 +46,7 @@ pnpm test ### Storybook We use **Storybook** for visual testing of components. All components must include Storybook documentation. -Run the following command to view your components at `localhost:6006`: +Run the following command to view your components at `http://localhost:6006`: ```sh pnpm dev:storybook ``` From 4cda26ba65729a46a94fb1f788e803935fd017bd Mon Sep 17 00:00:00 2001 From: SEMIN Date: Mon, 13 Jan 2025 00:20:59 +0900 Subject: [PATCH 7/9] docs(contributing): add and refine commit message convention --- .github/CONTRIBUTING.md | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0113ece..410a8d9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -59,10 +59,23 @@ Before proposing changes, please **open an issue** to discuss the bug or feature ### Create a Pull Request 1. **Create a Branch** - Follow the branch naming convention: `/` + Follow the branch naming convention: `/-` (`ISSUENUMBER` is optional) ```sh - git checkout -b feat/your-feature - ``` + git checkout -b your-branch + ``` + + | **Category** | **Description** | + |--------------|-----------------------------------------------------| + | **feat** | Developing a new feature | + | **fix** | Fixing a bug | + | **hotfix** | Emergency fixes for immediate release | + | **chore** | Maintenance tasks or minor updates | + | **refactor** | Code refactoring without functional changes | + | **release** | Preparing for a new release version | + | **test** | Writing or modifying test cases | + | **docs** | Documentation updates or additions | + | **ci** | CI/CD pipeline updates | + | **build** | Changes to the build system or dependencies | 2. **Commit Changes** Write meaningful commit messages using the [Conventional Commits](https://www.conventionalcommits.org/) format: @@ -71,21 +84,12 @@ Before proposing changes, please **open an issue** to discuss the bug or feature ``` We recommend following the Conventional Commits standard for clear and consistent commit messages. Below is the suggested structure: + | Element | Requirement | Description | + |--------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `` | **Required** | Describes the purpose of the commit. Examples: `feat`, `fix`, `docs`, `style`, `refactor`, `test`. | + | `` | **Optional** | Specifies the affected module, file, or functionality. Limited to **20 characters** (e.g., `auth`, `header`). | + | `` | **Required** | A concise summary of the changes:
- Starts with a lowercase letter.
- Avoid ending with a period (`.`).
- Limited to **50 characters**. - Written in **English**. | - - `` (Required) - - Indicates the purpose or type of the commit. - - Examples: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore` - - - `` (Optional) - - Specifies the scope of the changes, such as the module, file name, or functionality affected. - - Limited to a maximum of 20 characters. - - - `` (Required) - - A brief summary of the changes made. - - Limited to 50 characters. - - Starts with a lowercase letter. - - Do not end with a period(.). - - Written in English. 3. **Push Changes** From 559c2dccc172f1e9aad087cecd4981344868749a Mon Sep 17 00:00:00 2001 From: SEMIN Date: Mon, 13 Jan 2025 00:29:43 +0900 Subject: [PATCH 8/9] docs(contributing): improve introduction by reducing redundancy --- .github/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 410a8d9..c52f44c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contributing to Sipe Design System -Welcome to our project! We want to make contributing to this project as easy and transparent as possible. -This document provides a clear guide on **how to contribute to Side(Sipe Design System)**. -We've outlined the process to ensure contributing is as easy and transparent as possible. +Welcome to our project! +We want to make contributing to **Side (Sipe Design System)** as straightforward and transparent as possible. +This document provides a clear guide to help you get started and contribute effectively. ### What is Side? Side refers to the Sipe Design System, our primary UI component library aimed at creating consistent and reusable interfaces. From 461af52d49e9298d98e8c0d0b14ef5922f2dfd7b Mon Sep 17 00:00:00 2001 From: SEMIN Date: Mon, 13 Jan 2025 00:30:19 +0900 Subject: [PATCH 9/9] docs(contributing): add minimum testing requirements --- .github/CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c52f44c..29d26df 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -39,9 +39,13 @@ pnpm create:component ### Testing We use **Vitest** for testing. All new features or changes must include **relevant test cases**. + ```sh pnpm test ``` +**Minimum Testing Requirements:** +- Cover all primary use cases. +- Ensure edge cases are tested. ### Storybook We use **Storybook** for visual testing of components.