Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

70 lines (44 loc) · 4.12 KB
Raw

Contributing to Visa Chart Components

Thank you for being a part of the Visa Chart Components (VCC) community. Before contributing (whether opening an issue or a PR), please read this document in its entirety.

Whenever a ticket or PR is opened, we will do our best to get back to you and guide you through our contribution process. Below are a few guidelines that will help you along the way.

Contents


# Reporting Issues

If you think you have found a bug or issue or have a feature request please start by making sure it hasn't already been reported, fixed, or implemented. You can search through existing issues and PRs to see if someone has reported one similar to yours.

# Opening an Issue

If you have identified a bug, issue, or feature request that has no existing PRs or tickets, create a new issue that briefly explains the problem, and provides a bit of background as to the circumstances that triggered it, and steps to reproduce it.

  • For code issues please include:

    • @visa/charts library version or specific component (@visa/bar-chart) version
    • Browser and version
    • A code example, link to a repo, gist or running site. This will help us repro and identify the issue.

  • For visual or layout problems, using images or animated gifs can help explain your issue.

  • For feature requests please include a link to any relevant examples, a screenshot, or even a sketch of your requested feature.

# Issue Guidelines

  • Begin the title with '[ComponentName]' where appropriate, and use a succinct description. "doesn't work" doesn't help others find similar issues.
  • Do not group multiple topics into one issue, but instead each should be its own issue.

# Contributing Code

Before contributing code or opening a PR, please open a feature request or issue (see above). This will help us identify whether we have already addressed the feature or issue in an upcoming release and assess how the feature or fix fits into our release plan.

# Architecture Philosophy

VCC is a well organized Monorepo for simplicity! The components are standard web components developed using Stencil can be reused directly in any web environment and/or framework. The development practices follows guardrails (e.g. linting, testing etc.) to help maintain consistency and quality.

# Branching Structure

All stable releases are tagged on master. At any given time, development represents the latest development version of the library. Patches or hotfix releases are prepared on an independent branch. We will do our best to keep development branch in good shape, with tests passing at all times.

# Setup

  1. Create an issue, if applicable, and then clone locally
  2. Create a branch off development.
  3. yarn or npm install
  4. yarn bootstrap or npm run bootstrap
  5. yarn start or npm run start

# Commit Messages and Pull Requests

This library needs to follow the Conventional Commit specification with an addition of Ticket/Issue Numbers. Add your issue number to each commit message. Remember that your commit messages are going to be used in creating the CHANGELOG.md file, so let that thought guide you to create quality commit messages.