Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 4.7 KB

CONTRIBUTING.md

File metadata and controls

65 lines (39 loc) · 4.7 KB
Raw

Contributing

Thanks for your interest in contributing to Ziggy! Contributions are welcome and will be credited.

To keep things running smoothly we ask you to follow a few guidelines when contributing. Please read and understand this contribution guide before creating an issue or pull request.

Etiquette

Be kind.

Viability

If you have an idea for a feature, we'd prefer you open a discussion before going to the trouble of writing code. We welcome your ideas, but we'd like to work with you to come up with solutions that work well for the project as a whole. We're usually pretty responsive, so it shouldn't take us long to figure out whether and how best to implement your idea.

Procedure

Before filing an issue:

  • Attempt to replicate the problem, to ensure that it wasn't a coincidence.
  • Check to make sure your feature suggestion isn't already present within the project.
  • Check the pull requests tab to ensure that your feature or bugfix isn't already in progress.

Before submitting a pull request:

  • Check the codebase to ensure that your feature doesn't already exist.
  • Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

Tests

Please write tests for any fixes or new features you contribute. We use Orchestra Testbench and Pest for PHP tests and Vitest for JavaScript.

You can run PHP tests with vendor/bin/pest and JavaScript tests with npm test.

If you need any help with this please don't hesitate to ask.

If your filesystem uses CRLF instead of LF line endings (e.g. Windows) you may see errors related to that when running tests. To fix this you can run git config --global core.autocrlf input to configure Git to preserve the line endings from the repository when cloning. You may have to clone this repository again.

Types

TypeScript types are included with Ziggy and maintained manually.

To test the type definitions, open tests/js/types.ts in an editor or IDE with TypeScript support. This file contains sample code using Ziggy's route() function, and can be used to ensure that specific examples do or don't type-check as expected. To add a test for code that should work, add the code (with a comment explaining its purpose) and verify that it doesn't create any type errors. To add a test for code that should not work, and should generate a type error, add the code with a // @ts-expect-error annotation, and verify that without the annotation it generates a type error and with the annotation it doesn't.

See also tighten/ziggy-type-testing.

Releases

Note

Ziggy publishes two different versions of its built assets to Packagist and NPM (the NPM build does not bundle in our external NPM dependencies). The ones that live in the repo are for Composer/Packagist, and the ones for NPM are built automatically when running npm publish and can be reverted/deleted after publishing.

To create and release a new version of Ziggy:

  • Update the version field in package.json and package-lock.json to the new version number not prefixed with v by running npm version <version> --no-git-tag-version (e.g. npm version 2.1.0 --no-git-tag-version).
  • Update the Changelog.
  • Rebuild Ziggy's assets with npm run build.
  • Commit the changes and push them to the corresponding branch (e.g. 2.x or main).
  • Create and publish a new release on GitHub, creating a new tag targeting the right branch, named with the version number prefixed with v (e.g. v2.1.0).
    • This will trigger a run of the release workflow in .github/workflows/release.yml, which will rebuild Ziggy's assets and publish the new version to NPM.
    • For beta/pre-release versions, use an appropriate suffix (e.g. -beta.1, for a version of [v]3.0.0-beta.1) and mark the GitHub release as a pre-release. Pre-releases are published to NPM under the next tag, so they are not installed by default and must be explicitly requested with npm install ziggy-js@next.

Requirements

  • PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer.
  • Tlint styles - Tighten-specific styles. Tlint is built for apps, so there are some settings that might not make sense in a package, but download Tlint and run it on your pull requests to see if it suggests any reasonable changes.
  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.