Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 1.07 KB

Contributing

All contributions are welcome! If you would like to make some changes, follow these steps:

  • Fork the project and clone it
cd my-projects
git clone git@github.com:nuxt-modules/i18n.git
  • Install the module's dependencies:
cd i18n
pnpm i

Note: This project is using pnpm.

  • Setup type generation
pnpm dev:prepare
  • Create a new branch for your changes:
git checkout -b my-new-feature
  • Code, code, code!
  • Run ESLint, Prettier and Vitest
pnpm lint # lint and format check
pnpm fix  # auto fix for lint and format
pnpm test:unit # unit tests
pnpm test:spec # e2e tests
  • Commit and push your changes
  • Submit awesome PRs

Documentation

you can contribute for documentation

  • Setup docs
pnpm docs:setup
  • Start the docs server:
pnpm docs:dev
  • Write some doc by editing files in docs/ directory

Please make sure all languages are in sync. If you don't speak a particular language, insert english text in place.

  • Commit and push your changes
  • Once you're done, submit that shiny PR!