diff --git a/.all-contributorsrc b/.all-contributorsrc index 35439a20..d09bb908 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,7 +1,6 @@ { "files": [ - "README.md", - "README_cn.md" + "CONTRIBUTORS.md" ], "imageSize": 100, "commit": false, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..27d8a508 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,105 @@ +# Contributing + +## Setup your machine + +`alist` is written in [Go](https://golang.org/) and [React](https://reactjs.org/). + +Prerequisites: + +- [git](https://nodejs.org/zh-cn/) +- [Go 1.17+](https://golang.org/doc/install) +- [gcc](https://gcc.gnu.org/) +- [nodejs](https://nodejs.org/) + +Clone `alist` and `alist-web` anywhere: + +```shell +$ git clone https://github.com/Xhofe/alist.git +$ git clone https://github.com/Xhofe/alist-web.git +``` +You should switch to the dev branch for development. + +## Preview your change +### backend +```shell +$ go run alist.go +``` +### frontend +```shell +$ yarn dev +``` + +## Create a commit + +Commit messages should be well formatted, and to make that "standardized". + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +