Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1017 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 1017 Bytes

Contributing to d2-ui

Thank you for considering to contribute to d2-ui. In this document you can find out how to do so in accordance with our standards.

Getting started

  • Make sure you have a JIRA account.
  • Make sure you have a GitHub account.
  • Submit a Jira ticket for your issue if one does not already exist
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
    • A ticket is not necessary for trivial changes
  • Fork the repository on GitHub.

Issue tracking

D2-UI issues can be reported and explored in our JIRA filtered on components.

Submitting code for review

Submit your change as a pull request. Pull requests need to include:

  1. Good quality unit tests
  2. Relevant changes/additions to the examples
  3. Why the changes are relevant and neccessary