diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d15f39ba..5c07d8c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,18 @@ +# CONTRIBUTING + ## How to contribute to this project First, fork this repository by clicking the fork button. Next, clone your forked repo. -``` +```bash git clone --recursive https://github.com/hugo-fixit/FixIt.git && cd FixIt ``` Then, install the dev dependencies. -``` +```bash npm install ``` @@ -34,7 +36,7 @@ npm run start:production ``` -Finally, create a new pull request at https://github.com/hugo-fixit/FixIt/pulls to submit your contribution 🎉 +Finally, create a new pull request at to submit your contribution 🎉 ## Git standard for developers @@ -43,7 +45,8 @@ Finally, create a new pull request at https://github.com/hugo-fixit/FixIt/pulls | Branch | Description | | :-- | :-- | | master | _The branch open to the public and release versions_ | -| RC branch | _The development branch of the next version, e.g. v0.2.12-RC_ | +| dev | _The development branch of the next version_ | +| RC branch | _The release candidate branch of the next version, e.g. v0.2.12-RC_ | | single feature | _The branch to enhancements or fixes_ | ### Merge events @@ -67,7 +70,7 @@ example: #### Emoji -- https://gitmoji.dev +- - [vscode plugin](https://github.com/maixiaojie/git-emoji-zh.git) - utools plugin `GitEmoji`