Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

86 lines (62 loc) · 2.65 KB
Raw

Contributing 🐵

Hello, and welcome! Whether you are looking for help, trying to report a bug, thinking about getting involved in the project or about to submit a patch, this document is for you! Its intent is to be both an entry point for newcomers to the community (with various technical backgrounds), and a guide/reference for contributors and maintainers.

Consult the Table of Contents below, and jump to the desired section.

Development

This project uses the vue-cli for linting, testing, and building. See package.json for all currently used plugins.

Code Style

If it passes linting, YOLO. Improvements to ASCII art encouraged.

Linting

# Autofixes any linting issues
yarn lint

# Outputs linting issues that need to be fixed without fixing
yarn lint --no-fix

Running Tests

Swrv has a suite of unit tests that are meant to be as comprehensive as possible. They run in CI and are required to pass in order to merge.

# Run all tests
yarn test

# Run all tests and watch file changes to trigger a rerun (also enters jest mode to filter tests)
yarn test --watchAll

# Run just a single test file
yarn test use-swrv

Tests can get you most of the way there when developing a new feature. However, you will want to test it in a real app eventually.

Verifying the Build Output

This could be better experience. If you want to develop swrv and test that the esm/dist bundles are working correctly, you can run the build command and copy the bundle to your project.

yarn build

Output inside esm, and dist will contain output from tsc build. Move this into your project and change import statements. Using yarn link is an exercise left to the reader. Contributions to this doc are welcome if you get it working!

Deploying

Note: this is for maintainers of the repo, with access to publish to NPM

After merging a PR, you will want to get it up on the registry for everyone to use.

  1. bump the version according to semver in the package.json of the repo with the appropriate new version x.x.x
  2. git commit with the message chore(release) x.x.x directly to your local master.
  3. Build the library artifacts yarn build
  4. Login as an authorized npm user (has access to swrv npm package)
  5. npm publish
  6. Once published, git push to origin/master
  7. draft a github release following the naming conventions of the other releases.