Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.3 KB
Raw

Contributing guide

🚨 Note: we use yarn Plug'n'Play and workspaces now.

Development

Before getting started for development, you may need to setup your IDE for proper type hints since we're using Plug'n'Play installs.

yarn
yarn start

Note: if you are editing docusaurus/src/client/theme/**/*.css or docusaurus/src/locales/*.json, you should run yarn workspace @easyops-cn/docusaurus-search-local run copy-static-files each time you edited these files.

The yarn start command will watch and run both this theme itself and the example website parallelly. However, the search index is only available when you run build against the website!

So if your feature requires the search index, you should:

# Open a terminal to watch and run the theme.
yarn start:theme
# Open another terminal to build the website.
yarn build:website

Testing

Note: Please use Node >=16.15.0, or there maybe an issue that running test will be hanging.

yarn test

Publishing

There is the Release Please Action bot to handle publishing. Just merge the relevant release-PR, no worries.