From a227ae386d7caee25cec105dd01af048162e9ea7 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Sat, 25 Jul 2020 22:26:24 +0800 Subject: [PATCH] Updated the contribution guide. --- .github/CONTRIBUTING.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7413516..c72187d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,15 +2,21 @@ I want to thank you for sparing a time to improve this project! Here are some guidelines for contributingļ¼š -To ensure that the blog design is not confused, this project does not accept suggestions for design changes, such as color scheme, fonts, typography, etc. If your request is about an enhancement, it is recommended to first submit a `Feature Request` type issue to discuss whether your idea fits the project. +To ensure that the blog design is not confused, this project does not accept suggestions for design changes, such as color scheme, fonts, typography, etc. If your request is about an enhancement, it is recommended to first submit a [`Feature Request`](https://github.com/cotes2020/jekyll-theme-chirpy/issues/new?labels=enhancement&template=feature_request.md) issue to discuss whether your idea fits the project. Generally, contribute to the project by: -1. Fork this project. -2. Create a new branch `my-new-feature`(or `fix-a-bug`), then complete the development, commit and push. -3. Submit a new `Pull Request`. +1. Fork this project on GitHub and clone it locally. +2. Create a new branch named `feature/my-feature` (or `feature/fix-a-bug`), which branch from `develop`: + ```console + $ git checkout -b feature/ develop + ``` + > Please note that the new branch name must include the prefix `feature/`. + +3. After completing the development, commit and push to remote. +4. Submit a new **pull request** to the `develop` branch of upstream, i.e., `cotes2020/jekyll-theme-chirpy:develop`. --- -:tada:Your volunteering will make the open source world more beautiful, thanks again!:tada: \ No newline at end of file +:tada: Your volunteering will make the open source world more beautiful, thanks again! :tada: \ No newline at end of file