Skip to content

Latest commit

 

History

History
100 lines (68 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

100 lines (68 loc) · 2.32 KB
Raw

CONTRIBUTING

Contributions are always welcome, no matter how big or small the contribution. Before contributing, please read the Code of Conduct.

TLDR;

> yarn
> yarn dev

In another terminal window:

> yarn --cwd ./docs && yarn --cwd ./docs dev

Getting Started

  1. Fork this repo to your personal GitHub account.

  2. Clone your personal fork

    > git clone git@github.com:<username>/viewable.git

  3. Add upstream as a remote

    > git remote add upstream git@github.com:svelte-plugins/viewable.git

  4. Install dependencies and watch for changes in source

    If you do not have yarn installed, run npm i -g yarn

    > yarn && yarn dev

  5. Install dependencies and start the docs server

    > yarn --cwd ./docs && yarn --cwd ./docs dev

  6. Open the following url http://localhost:3000. That's it!

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed the API, update the README with your changes.
  4. Follow the instructions in the PR template

Commit Messages

Please make sure your commits follow semantic commit messaging.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

Types

  • chore: Updating packages, gulp tasks, etc; no production code change.
  • docs: Changes to the documentation.
  • feat: New feature for the user, not a new feature for build script.
  • fix: Bug fix for the user, not a fix to a build script.
  • refactor: Refactoring production code, eg. renaming a variable.
  • style: Formatting, missing semi colons, etc; no production code change.
  • test: Adding missing tests, refactoring tests; no production code change.

Usage

  • chore: add Oyster build script
  • docs: explain hat wobble
  • feat: add beta sequence
  • fix: remove broken confirmation message
  • refactor: share logic between 4d3d3d3 and flarhgunnstow
  • style: convert tabs to spaces
  • test: ensure Tayne retains clothing

License

By contributing to this repository, you agree that your contributions will be licensed under its MIT license.