Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

50 lines (30 loc) · 2.5 KB

Contributing

Requirements

  • Node.js: >=18
  • PNPM: >=8

Getting Started

1. Clone the repo

git clone [email protected]:matthewvolk/bigrequest.git && cd bigrequest

2. Install dependencies

corepack enable pnpm
pnpm i

Automated Type Generation for the BigRequest HTTP Client

The BigCommerce API is constantly changing. As a best effort to ensure that the types for the request client stay updated in response to changes in the BigCommerce Open API Specs repository, a scheduled GitHub Action runs once a night to re-generate types against the latest version of the bigcommerce/docs repository.

If changes are introduced during the GitHub Action workflow, the action will open a PR for review (example: matthewvolk/bigrequest#30).

The PR should be analyzed to determine if the changes introduced by the action should result in a patch, minor, or major release. If a new release is required, the branch associated with the PR should be pulled down locally, pnpm changeset should be run on the branch, and the PR should be updated so that when merged, the changeset triggers a release to NPM (example: matthewvolk/bigrequest#31).

Publishing

The BigRequest monorepository uses changesets to handle changelogs, semantic versioning, and publishing to the NPM public registry. In order for your pull request to be merged, you must think about whether or not the changes you introduce should result in releasing a new version of one of the packages to the NPM registry.

Examples:

  • Pull request introducing changes to the root README.md: Does not need to be published to NPM.
  • Pull request introducing changes to bigrequest, e.g., src/rest.ts: Should be published to NPM.

If you determine that your pull request introduces changes that need to be released, you should submit a changeset with your Pull Request.

Navigate to the root bigrequest repository and run:

pnpm changeset

An interactive prompt will take you through the process of adding your changeset.

Once your PR is merged, our GitHub Action will handle the process of versioning and publishing your changes to NPM. No further action is needed from you.