Contributing

Contributions are welcome and will be fully credited. Here is a little bit you should know, before you send your contribution:

😄 Welcome examples

• Failing regression tests as bug reports.
• Documentation improvements, e. g. fix a typo, add a section.
• New features for existing extensions, e. g. a new configureable option.
• Well explained, non-breaking changes to the core.

🛠️ Set up the development environment

Prerequisites

You'll need following installed first:

• Git
• Node
• pnpm
• git-cz

# pnpm
sudo npm install -g pnpm

# git-cz
sudo npm install -g git-cz

Fork and clone the repo to your local machine

git clone [email protected]:yourname/yiitap.git

Install dependencies

cd yiitap
pnpm install

Run dev

Build all package first:

pnpm build

Run vue app by default:

pnpm dev

Open http://localhost:5173/yiitap in your favorite browser.

🧑🏻‍💻 Develop and Commit

Create new feature branch

git checkout -b feat/new-feature

Code changes

Make specific code changes for your new feature.

lint, test and build

lint

pnpm lint

Make sure there are no lint issues, fix it using:

pnpm lint-fix

test

pnpm test-ci

build

pnpm build

Preview

cd apps/vue
pnpm preview

You may go to http://localhost:4173/yiitap to check if your changes work as expected.

Generate changeset

pnpm changeset

Commit

Now, it is safe to commit.

git add .
git cz

🚀‍ Pull Request

Push your branch

git push origin feat/new-feature

Creat PR

We recommend create pr using template:

gh pr create --title "feat: new feature" --body-file .github/pull_request_template.md

Or create pull request at Github.

📃 Documentation

Documentation is as important as code. Please update the documentation repository corresponding to any alterations you make in the code.

• Code Repo: Modify the code here.
• Documentation Repo: Update or add documentation here to reflect changes made in the Yiitap repository.