ZenBrowserMirrors/www
1
0
Fork 0
mirror of https://github.com/zen-browser/www.git synced 2025-07-07 08:55:32 +02:00
Code Issues Projects Releases Packages Wiki Activity
www/CONTRIBUTING.md

1.6 KiB
Raw Permalink Blame History

Zen Browser Website

Thank you for wanting to contribute to Zen Browser Website. We are thrilled to welcome you to our community. Before you start, please read this document to understand how you can contribute to this project.

How to Contribute

  1. Fork the Zen Browser Website repository.
  2. Clone the Zen Browser Website repository to your local machine.
git clone git@github.com:<YOUR_GITHUB_USERNAME>/www.git # SSH
git clone https://github.com/<YOUR_GITHUB_USERNAME>/www.git # HTTPS
gh repo clone <YOUR_GITHUB_USERNAME>/www # GitHub CLI
  1. Change directory to the cloned repository.
cd www
  1. Create a branch for your contribution.
git checkout -b <BRANCH_NAME>
  1. Start the development environment.
pnpm install
pnpm dev

  1. Make your changes.

  2. Once you're done, commit your changes.

git add .
git commit -m "feat: add new feature description"

Note

Please follow the commit guidelines described below.

Commit Guidelines

This project follows the Conventional Commits specification.

Commits must be signed. You can learn more about Commit Signing here.

Commit Message Guidelines

  • Commit messages must include a "type" as described in Conventional Commits
  • Commit messages must start with a lowercase letter
  • Commit messages must not end with a period .
  • Commit messages must be in English sorry for the constraint