Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
103 lines (72 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

103 lines (72 loc) · 3.69 KB

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 24 or later
  • npm CLI
  • Prerequisite 1
  • Prerequisite 2
  • Prerequisite 3

📝 Project-specific notes

Tip

Please update this section with helpful notes for contributors.

👷 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 git@github.com:prismicio-community/prismic-cli-poc.git
cd prismic-cli-poc
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.
node --run dev

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

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

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

# Test your changes before requesting a review.
# All changes should be tested. No failing tests are allowed.
node --run test
# Run only unit tests (optionally in watch mode):
node --run unit
node --run unit:watch
# Run only type tests
node --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.

# Prereleases are published to npm automatically to upon pushing commits.
# Install the prerelease using the `pr-${number}` tag.
npm install prismic-cli-poc@pr-101

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

🚀 Publish

Caution

Publishing is restricted to the Prismic team.4

This repository uses Release Please. To publish changes in main, merge the pending Release Please PR.

If you don't see a pending PR, there are no changes to publish from main.

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. ↩