diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8ce47b2..6064b03c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,106 +2,76 @@ ## Setup your machine -`OpenList` is written in [Go](https://golang.org/) and [React](https://reactjs.org/). +`OpenList` is written in [Go](https://golang.org/) and [SolidJS](https://www.solidjs.com/). Prerequisites: - [git](https://git-scm.com) -- [Go 1.20+](https://golang.org/doc/install) +- [Go 1.24+](https://golang.org/doc/install) - [gcc](https://gcc.gnu.org/) - [nodejs](https://nodejs.org/) -Clone `OpenList` and `OpenList-Frontend` anywhere: +## Cloning a fork + +Fork and clone `OpenList` and `OpenList-Frontend` anywhere: ```shell -$ git clone https://github.com/OpenListTeam/OpenList.git -$ git clone --recurse-submodules https://github.com/OpenListTeam/OpenList-Frontend.git +$ git clone https://github.com//OpenList.git +$ git clone --recurse-submodules https://github.com//OpenList-Frontend.git +``` + +## Creating a branch + +Create a new branch from the `main` branch, with an appropriate name. + +```shell +$ git checkout -b ``` -You should switch to the `main` branch for development. ## Preview your change + ### backend + ```shell $ go run main.go ``` + ### frontend + ```shell $ pnpm dev ``` ## Add a new driver + Copy `drivers/template` folder and rename it, and follow the comments in it. ## 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**: - -``` -(): - - - -