Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (59 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

100 lines (59 loc) · 3.02 KB

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.

Community and policies

By contributing, you agree to follow the repository's code of conduct and license terms.

If your contribution includes substantial AI-assisted content, disclose the tools used and the scope of assistance in the pull request.

Create a commit

Commit messages should be well formatted, and to make that "standardized".

Submit your pull request. For PR titles, follow Conventional Commits.

OpenListTeam#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.

AI Disclosure

If your pull request includes substantial AI-assisted content, disclose it in the PR description.

Please include:

  • Tools used, such as ChatGPT, GitHub Copilot, Claude, Cursor, or other AI tools.
  • Usage scope, such as code generation, refactoring, documentation, tests, translation, or review assistance.
  • Confirmation that you have reviewed and validated all AI-assisted content before submission.
  • Confirmation that the submitted content complies with this repository's license and contribution policies.

Minor AI assistance, such as typo fixes, autocomplete, formatting suggestions, or wording polish, does not need to be disclosed.

Thank you for your contribution! Let's make OpenList better together!