From fa7719db517c269c1508b5ac10420e45cc7dc761 Mon Sep 17 00:00:00 2001 From: ryanycw Date: Fri, 15 Sep 2023 19:31:53 +0800 Subject: [PATCH] fix: linter --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 21 ++++++++++++--------- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index eecfc3be..88ed376e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -Please follow the guidelines in [Contribution.md](https://github.com/social-tw/social-tw-website/blob/main/CONTRIBUTING.md) first, then start to create your pull request here. +Please follow the guidelines in [Contribution.md](https://github.com/social-tw/social-tw-website/blob/main/CONTRIBUTING.md) first, then start to create your pull request here. ## Summary diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a6cb647..708dc581 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,17 @@ # Welcome to Unirep Social TW contributing guideline 👋🏻 -Thank you for investing your time in contributing to our project! + +Thank you for investing your time in contributing to our project! This guide will give you an overview of the contribution workflow, from opening an issue, creating a PR, reviewing, and merging the PR. -## How do we start the development? - 1. Create the branch under social-tw, and name it with the convention of "purpose-scope-unit" (E.g. feat-login-backend) - [Reference to more prefix of the branch](https://wadehuanglearning.blogspot.com/2019/05/commit-commit-commit-why-what-commit.html) - 2. Create a pull request and name it with the status and the same name as the branch. E.g. [WIP] feat-post-smart-contract - 3. Once the development is done, you can ask for a review. The PR can be merged after approval by **at least one other team member**. +## How do we start the development? + +1. Create the branch under social-tw, and name it with the convention of "purpose-scope-unit" (E.g. feat-login-backend) + [Reference to more prefix of the branch](https://wadehuanglearning.blogspot.com/2019/05/commit-commit-commit-why-what-commit.html) +2. Create a pull request and name it with the status and the same name as the branch. E.g. [WIP] feat-post-smart-contract +3. Once the development is done, you can ask for a review. The PR can be merged after approval by **at least one other team member**. ## Steps for creating good issues. - 1. When encountering an issue while developing, ensure the branch is pushed. (so that people can see what exactly you're working on) - 2. Create an issue and mention the issue in the corresponding pull request. - 3. Assign the person who can solve the issue with you. (If you don't know who to assign to, go to our discord and share the issue) + +1. When encountering an issue while developing, ensure the branch is pushed. (so that people can see what exactly you're working on) +2. Create an issue and mention the issue in the corresponding pull request. +3. Assign the person who can solve the issue with you. (If you don't know who to assign to, go to our discord and share the issue)