Skip to content

Latest commit

 

History

History
65 lines (52 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

65 lines (52 loc) · 3.07 KB
Raw

Fish Tank Vue Component Contribution Guide

Please take a few moments to review the following guidelines before contributing components to the Fish Tank Design System Library.

Table Of Contents

How to Contribute

The basic workflow is the following:

  • Fork the repository
  • Create a new branch off the dev branch. Do Not Make Changes Directly On Your Forks Dev Branch.
  • Create your new feature or edit code, following our code quality guidelines and format. Commit your changes
  • Make a pull request to main project's dev branch.
  • Always work in a new branch in your fork. Making changes on your fork's dev or master branch can cause problems later on when trying to merge changes. (See The beginner's guide to contributing to a GitHub project)

Creating Your Branch

  • Use a descriptive title no more than 64 characters long, begining with "feat/". This will be used as the commit message when your PR is merged.

Development Setup

Clone this repository and run the following commands to build the project.

$ yarn install 
# or
$ npm install

$ yarn serve
# or
$ npm run serve

Source Code Setup

  • Individual Vue components are located in src/components/.
  • Preview Pages for each component are located in dev/views/.
  • Unit tests are located in src/test/unit/.

Writing your component

Read our contributing components guidelines

Writing your component styles

Read our contributing CSS guidelines

Unit Testing

Read our testing guidelines

Writing Your Commit & Creating Pull Requests

  • Please use the Conventional Commits format to title and create your commits. Some example types are:

    • feat: A new feature
    • fix: A bug fix
    • docs: Documentation only changes
    • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
    • refactor: A code change that neither fixes a bug or adds a feature
    • perf: A code change that improves performance
    • test: Adding missing tests
    • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

  • If applicable, Please reference the issue # that the PR resolves, something like Fixes #1234 or Resolves #6458 (See closing issues using keywords)