0c27b4bd47
[skip ci] * docs(contributing): update guidelines * docs(contributing): clarify fork * docs(contributing): sync translation Co-authored-by: Yinan Qin <39023210+elysia-best@users.noreply.github.com> Signed-off-by: MadDogOwner <xiaoran@xrgzs.top> * docs(contributing): add label and cc reminder * docs(contributing): remove ensure new branch from checklist * docs(contributing): replace generic GitHub URLs with user-specific ones * docs(contributing): make branch deletion after PR merge optional * docs(contributing): keep --recurse-submodules --------- Signed-off-by: MadDogOwner <xiaoran@xrgzs.top> Co-authored-by: Yinan Qin <39023210+elysia-best@users.noreply.github.com>
1.9 KiB
Contributing
Setup your machine
OpenList is written in Go and SolidJS.
Prerequisites:
Cloning a fork
Fork and clone OpenList and OpenList-Frontend anywhere:
$ git clone https://github.com/<your-username>/OpenList.git
$ git clone --recurse-submodules https://github.com/<your-username>/OpenList-Frontend.git
Creating a branch
Create a new branch from the main branch, with an appropriate name.
$ git checkout -b <branch-name>
Preview your change
backend
$ go run main.go
frontend
$ 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".
Submit your pull request. For PR titles, follow Conventional Commits.
https://github.com/OpenListTeam/OpenList/issues/376
It's suggested to sign your commits. See: How to sign commits
Submit a pull request
Please make sure your code has been formatted with go fmt or prettier before submitting.
Push your branch to your openlist fork and open a pull request against the main branch.
Merge your pull request
Your pull request will be merged after review. Please wait for the maintainer to merge your pull request after review.
At least 1 approving review is required by reviewers with write access. You can also request a review from maintainers.
Delete your branch
(Optional) After your pull request is merged, you can delete your branch.
Thank you for your contribution! Let's make OpenList better together!