@usds.gov/questionable-core

Questionable Core

This is the platform agnostic, core project behind the @usds.gov/questionable React component and the @usds.gov/questionable-console runtime.

Development

This project is built using tooling from the NPM ecosystem, TypeScript, Node. For convenience, this guide assumes the use of the Github CLI, but vanilla git commands will work just as well.

To get started developing:

• Verify that Yarn is installed:

npm install -g yarn

• Clone the project:

gh repo clone usds/questionable

• Switch to project root:

cd questionable

• Install project:

yarn install

• Build project

yarn workspace @usds.gov/questionable build

Contributing

Commit messages and Pull Request names should follow the Conventional Commit standard. The tl;dr is: your commit message should be short and specific, e.g. feat(analytics): implements google analytics or fix(ci): update lodash version to latest.

All development should be done on a branch. On completion of work, submit a Pull Request for that branch into main. The PR title should also follow the commit standard.

Releasing

Whenever minor/major changes are ready for release (i.e. merged into main), the project should be compiled and published to NPM.

yarn publish