Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 1.54 KB

Spek Website

Thank you for wanting to contribute to Spek 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 Spek Website repository.
  2. Clone the Spek 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 run dev

  1. Make your changes.

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

git add .
git commit -m "Your commit message"

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 capital letter
  • Commit messages must not end with a period .
  • Commit messages must be in English sorry for the constraint