Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 1.34 KB
Raw

How to contribute to Rocketact

Do you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible.

Do you want to contribute to the source code?

Use Node >= 10 version as development environment.

Prepare workspace

git clone https://github.com/jdf2e/rocketact.git
cd rocketact
yarn && yarn bootstrap
cd packages/rocketact-scripts/test/fixture/simple/ && yarn && cd -

Build

yarn build
# or build a specific package
yarn build -- --scope rockeatct

Running tests

yarn test
# or start watch mode
yarn test -- --watch

Commit changes

yarn commit

Do you want to contribute to the Rocketact documentation?

Rocketact uses Docusaurus to maintain its documentation.

If you want to preview the website locally, you can:

cd docusaurus/website
yarn
yarn start

Changes made to the documentation files will be reloaded into browser.

❤️❤️❤️ Thanks! ❤️❤️❤️