Contributing Guide

Thank you for your interest in contributing to FactoryJS documentation.

How to Contribute

Fork this repository from GitHub link and clone it. First Contributions would be helpful.

git clone git@github.com:<your-username>/factory-js.github.io.git
cd factory-js.github.io

Install the pnpm with Corepack. Run the following in the project root:
```
corepack enable pnpm
```
Install packages.
```
pnpm install
```
Create a branch and checkout.
```
git switch -c your-new-branch-name
```
Code and commit your changes.
```
git commit -m 'add a new feature'
```

Run linters in the project root before pushing the PR.

pnpm run secretlint
pnpm run type-check
pnpm run lint
pnpm run format

Push your changes and open the PR.
```
git push -u origin your-branch-name
```
Rename your PR title to comply with Conventional Commits. CI will automatically verify this.
You don't need to change commit messages because we use squash merge.
Generally, you can use the docs: when you intend to improve or fix documentation, and it is rare that you will need to use other types.
Please ensure all CI checks have passed. That's all! 🎉