Skip to content

Latest commit

 

History

History
122 lines (88 loc) · 4.24 KB

CONTRIBUTING.md

File metadata and controls

122 lines (88 loc) · 4.24 KB
Raw

Contributing

This package is primarily maintained by Prismic1. External contributions are welcome. Ask for help by opening an issue, or request a review by opening a pull request.

⚙️ Setup

The following setup is required to work on this project:

  • Node.js
  • npm CLI

📝 Project-specific notes

Tip

Please update this section with helpful notes for contributors.

Network requests

  • All API network requests are called through the private CustomTypesClient.prototype.fetch method.

TSDocs

  • All public APIs should have TSDoc comments.
  • TSDoc comments should be clear and concise. They should give users just enough context to understand how and when to use an API.

Write tests

  • Any change to this library should be tested. A test can be as simple as ensuring a method calls the correct endpoint.
  • Tests should be placed in the test directory using the existing file name convention.
  • Tests are written using Vitest.
  • Fixtures are provided using the custom it function from test/__testutils__/it.ts. See it.ts for a list of provided fixtures.

👷 Develop

Note

It's highly recommended to discuss your changes with the Prismic team before starting by opening an issue.2

A short discussion can accellerate your work and ship it faster.

# Clone and prepare the project.
git clone [email protected]:prismicio/prismic-custom-types-client.git
cd prismic-custom-types-client
npm install

# Create a new branch for your changes (e.g. lh/fix-win32-paths).
git checkout -b <your-initials>/<feature-or-fix-description>

# Start the development watcher.
# Run this command while you are working on your changes.
npm run dev

# Build the project for production.
# Run this command when you want to see the production version.
npm run build

# Lint your changes before requesting a review. No errors are allowed.
npm run lint
# Some errors can be fixed automatically:
npm run lint -- --fix

# Format your changes before requesting a review. No errors are allowed.
npm run format

# Test your changes before requesting a review.
# All changes should be tested. No failing tests are allowed.
npm run test
# Run only unit tests (optionally in watch mode):
npm run unit
npm run unit:watch
# Run only type tests
npm run types

🏗️ Submit a pull request

Note

Code will be reviewed by the Prismic team before merging.3

Request a review by opening a pull request.

# Open a pull request. This example uses the GitHub CLI.
gh pr create

# Someone from the Prismic team will review your work. This review will at
# least consider the PR's general direction, code style, and test coverage.

# When ready, PRs should be merged using the "Squash and merge" option.

🚀 Publish

Caution

Publishing is restricted to the Prismic team.4

# Checkout the main branch and pull the latest changes.
git checkout main
git pull

# Perform a dry-run and verify the output.
# If it looks good, release a new version.
npm run release:dry
npm run release

# Or release an alpha.
# Perform a dry-run and verify the output.
# If it looks good, release a new alpha version.
npm run release:alpha:dry
npm run release:alpha

Footnotes

  1. This package is maintained by the DevX team. Prismic employees can ask for help or a review in the #team-devx Slack channel. ↩

  2. Prismic employees are highly encouraged to discuss changes with the DevX team in the #team-devx Slack channel before starting. ↩

  3. Code should be reviewed by the DevX team before merging. Prismic employees can request a review in the #team-devx Slack channel. ↩

  4. Prismic employees can ask the DevX team for npm publish access. ↩